eu.etaxonomy.cdm.io.common

Class XmlImportBase<CONFIG extends XmlImportConfiguratorBase<STATE>,STATE extends XmlImportState<CONFIG,?>>

java.lang.Object

eu.etaxonomy.cdm.api.application.CdmRepository

eu.etaxonomy.cdm.io.common.CdmIoBase<STATE,ImportResult>

eu.etaxonomy.cdm.io.common.CdmImportBase<CONFIG,STATE>

eu.etaxonomy.cdm.io.common.XmlImportBase<CONFIG,STATE>

All Implemented Interfaces:

ICdmRepository, IIoObserver, ICdmImport<CONFIG,STATE>, ICdmIO<STATE>, IIoObservable, java.io.Serializable, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

MarkupDocumentImport, SDDImport

public abstract class XmlImportBase<CONFIG extends XmlImportConfiguratorBase<STATE>,STATE extends XmlImportState<CONFIG,?>>
extends CdmImportBase<CONFIG,STATE>
implements IIoObserver

Base class for XML imports

Since:

28.06.2011

Author:

a.mueller

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class eu.etaxonomy.cdm.io.common.CdmImportBase

CdmImportBase.TermMatchMode

Field Summary

Fields inherited from class eu.etaxonomy.cdm.io.common.CdmImportBase

CREATE, IMAGE_GALLERY, READ_MEDIA_DATA, uuidUserDefinedAnnotationTypeVocabulary, uuidUserDefinedExtensionTypeVocabulary, uuidUserDefinedFeatureVocabulary, uuidUserDefinedIdentifierTypeVocabulary, uuidUserDefinedKindOfUnitVocabulary, uuidUserDefinedLanguageVocabulary, uuidUserDefinedMarkerTypeVocabulary, uuidUserDefinedMeasurementUnitVocabulary, uuidUserDefinedModifierVocabulary, uuidUserDefinedNamedAreaLevelVocabulary, uuidUserDefinedNamedAreaVocabulary, uuidUserDefinedNomenclaturalStatusTypeVocabulary, uuidUserDefinedPresenceAbsenceVocabulary, uuidUserDefinedRankVocabulary, uuidUserDefinedReferenceSystemVocabulary, uuidUserDefinedStateVocabulary, uuidUserDefinedStatisticalMeasureVocabulary, uuidUserDefinedTaxonRelationshipTypeVocabulary

Fields inherited from class eu.etaxonomy.cdm.io.common.CdmIoBase

INCLUDE_UNPUBLISHED, ioName, NO_UNPUBLISHED

Fields inherited from class eu.etaxonomy.cdm.api.application.CdmRepository

applicationContext

Fields inherited from interface eu.etaxonomy.cdm.io.common.ICdmIO

FEATURE_STORE, NOMREF_STORE, REFERENCE_STORE, SPECIMEN_STORE, TAXON_STORE, TAXONNAME_STORE, TEAM_STORE

Constructor Summary

Constructors

Constructor and Description
XmlImportBase()

Method Summary

Modifier and Type	Method and Description
protected void	fireSchemaConflictEventExpectedStartTag(java.lang.String elName, javax.xml.stream.XMLEventReader reader)
protected java.io.InputStream	getInputStream(CONFIG config) Returns an input stream for the given source.
protected javax.xml.stream.XMLEventReader	getStaxReader(STATE state) Returns the StAX-Reader (XMLEventReader) for the source.
void	handleEvent(IIoEvent event)
protected boolean	isEndingElement(javax.xml.stream.XMLEventReader reader, java.lang.String elName)
protected boolean	isEndingElement(javax.xml.stream.events.XMLEvent event, java.lang.String elName)
protected boolean	isStartingElement(javax.xml.stream.XMLEventReader reader, java.lang.String elName) TODO namespace
protected boolean	isStartingElement(javax.xml.stream.events.XMLEvent event, java.lang.String elName)
protected void	parseSAX(STATE state, ImportHandlerBase handler) Parses the source file with the given handler
protected boolean	validateStartOfDocument(javax.xml.stream.XMLEventReader reader)

Methods inherited from class eu.etaxonomy.cdm.io.common.CdmImportBase

addOriginalSource, addOriginalSource, doubleFromString, fillMissingEpithets, fillMissingEpithetsForTaxa, getAcceptedTaxon, getAnnotationType, getByteArray, getDefaultResult, getDefaultTaxonDescription, getExtensionType, getExtensionType, getFeature, getFeature, getFeaturePlaceholder, getIdentiferType, getImageMedia, getImageMedia, getImageMedia, getKindOfUnit, getLanguage, getLanguage, getMarkedTaxonDescription, getMarkerType, getMarkerType, getMarkerType, getMarkerType, getMeasurementUnit, getModifier, getNamedArea, getNamedArea, getNamedArea, getNamedAreaLevel, getNoDataResult, getNomenclaturalStatusType, getPresenceTerm, getPresenceTerm, getRank, getReferenceSystem, getSpecimenDescription, getSpecimenDescription, getStateTerm, getStateTerm, getStatisticalMeasure, getTaxonDescription, getTaxonDescription, getTaxonNameDescription, getTaxonNameDescription, getTaxonRelationshipType, getVocabulary, intFromString, makeTree, makeTreeMemSave, NB, nullSafeBoolean, nullSafeDouble, nullSafeFloat, nullSafeInt, parseAuthorString, saveNameRelations

Methods inherited from class eu.etaxonomy.cdm.io.common.CdmIoBase

addObserver, addObservers, check, commitTransaction, countObservers, countSteps, doCheck, doInvoke, fire, fireProgressEvent, fireWarningEvent, fireWarningEvent, getInstance, getObservers, getSuccessString, invoke, isBlank, isIgnore, isNotBlank, removeObserver, removeObservers, rollbackTransaction, startTransaction, startTransaction, updateProgress, updateProgress, warnProgress

Methods inherited from class eu.etaxonomy.cdm.api.application.CdmRepository

authenticate, clearSession, getAgentService, getAmplificationService, getAnnotationService, getAuthenticationManager, getBean, getClassificationService, getCollectionService, getCommonService, getDatabaseService, getDescriptionService, getDescriptiveDataSetService, getEntityConstraintViolationService, getEntityValidationService, getEventBaseService, getFeatureNodeService, getFeatureTreeService, getGrantedAuthorityService, getGroupService, getIdentificationKeyService, getLocationService, getLongRunningTasksService, getMediaService, getMetadataService, getNameService, getOccurrenceService, getPermissionEvaluator, getPolytomousKeyNodeService, getPolytomousKeyService, getPreferenceService, getPrimerService, getProgressMonitorService, getReferenceService, getRegistrationService, getRightsService, getSequenceService, getSession, getSessionFactory, getTaxonNodeService, getTaxonService, getTermNodeService, getTermService, getTermTreeService, getTransactionManager, getUserService, getVocabularyService, NewConversation, setApplicationContext, setDataSource, setSessionFactory, setTransactionManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface eu.etaxonomy.cdm.io.common.ICdmImport

invoke

Methods inherited from interface eu.etaxonomy.cdm.io.common.ICdmIO

check, countSteps, fire, updateProgress, updateProgress, warnProgress

Methods inherited from interface eu.etaxonomy.cdm.io.common.IIoObservable

addObserver, addObservers, countObservers, getObservers, removeObserver, removeObservers

Constructor Detail

XmlImportBase

public XmlImportBase()

Method Detail

fireSchemaConflictEventExpectedStartTag

protected void fireSchemaConflictEventExpectedStartTag(java.lang.String elName,
                                                       javax.xml.stream.XMLEventReader reader)
                                                throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

validateStartOfDocument

protected boolean validateStartOfDocument(javax.xml.stream.XMLEventReader reader)
                                   throws javax.xml.stream.XMLStreamException

Parameters:

r -

Returns:

Throws:

javax.xml.stream.XMLStreamException

isStartingElement

protected boolean isStartingElement(javax.xml.stream.XMLEventReader reader,
                                    java.lang.String elName)
                             throws javax.xml.stream.XMLStreamException

TODO namespace

Parameters:

elName -

reader -

Returns:

Throws:

javax.xml.stream.XMLStreamException

isStartingElement

protected boolean isStartingElement(javax.xml.stream.events.XMLEvent event,
                                    java.lang.String elName)
                             throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

isEndingElement

protected boolean isEndingElement(javax.xml.stream.XMLEventReader reader,
                                  java.lang.String elName)
                           throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

isEndingElement

protected boolean isEndingElement(javax.xml.stream.events.XMLEvent event,
                                  java.lang.String elName)
                           throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

getInputStream

protected java.io.InputStream getInputStream(CONFIG config)

Returns an input stream for the given source.

Parameters:

config -

Returns:

getStaxReader

protected javax.xml.stream.XMLEventReader getStaxReader(STATE state)
                                                 throws javax.xml.stream.FactoryConfigurationError,
                                                        javax.xml.stream.XMLStreamException

Returns the StAX-Reader (XMLEventReader) for the source.

Parameters:

state -

Returns:

Throws:

javax.xml.stream.FactoryConfigurationError

javax.xml.stream.XMLStreamException

parseSAX

protected void parseSAX(STATE state,
                        ImportHandlerBase handler)
                 throws javax.xml.parsers.ParserConfigurationException,
                        org.xml.sax.SAXException,
                        java.io.IOException

Parses the source file with the given handler

Parameters:

is -

handler -

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

handleEvent

public void handleEvent(IIoEvent event)

Specified by:

handleEvent in interface IIoObserver