eu.etaxonomy.cdm.io.common

Class DbImportBase<STATE extends DbImportStateBase<CONFIG,STATE>,CONFIG extends DbImportConfiguratorBase<STATE>>

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.DbImportBase<STATE,CONFIG>

All Implemented Interfaces:

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

public abstract class DbImportBase<STATE extends DbImportStateBase<CONFIG,STATE>,CONFIG extends DbImportConfiguratorBase<STATE>>
extends CdmImportBase<CONFIG,STATE>
implements ICdmIO<STATE>, IPartitionedIO<STATE>

Since:

20.03.2008

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

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

ID_LIST_TOKEN

Constructor Summary

Constructors

Constructor and Description
DbImportBase(java.lang.String tableName, java.lang.String pluralString)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkSqlServerColumnExists(Source source, java.lang.String tableName, java.lang.String columnName)
protected boolean	doId(STATE state, ISourceable sourceable, long id, java.lang.String namespace)
protected boolean	doId(STATE state, ISourceable sourceable, java.lang.String id, java.lang.String namespace)
protected void	doInvoke(STATE state) invoke method to be implemented by implementing classes
protected void	doLogPerLoop(int count, int recordsPerLog, java.lang.String pluralString)
protected Annotation	doNotes(AnnotatableEntity annotatableEntity, java.lang.String notes) Adds a note to the annotatable entity.
protected User	getExistingUser(STATE state, java.lang.String userString, User user)
protected abstract java.lang.String	getIdQuery(STATE state)
java.lang.String	getPluralString()
protected abstract java.lang.String	getRecordQuery(CONFIG config)
protected java.lang.String	getTableName()
protected User	getUser(STATE state, java.lang.String userString)
protected java.util.Map<java.lang.String,java.lang.Object>	getValueMap(java.sql.ResultSet rs) Returns a map that holds all values of a ResultSet.
protected void	handleForeignKey(java.sql.ResultSet rs, java.util.Set<java.lang.String> idSet, java.lang.String attributeName) Reads a foreign key field from the result set and adds its value to the idSet.
protected boolean	loopNeedsHandling(int i, int recordsPerLoop) Returns true if i is a multiple of recordsPerTransaction
protected boolean	resultSetHasColumn(java.sql.ResultSet rs, java.lang.String columnName)

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, 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.ICdmIO

check, countSteps, fire, updateProgress, updateProgress, warnProgress

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

addObserver, addObservers, countObservers, getObservers, removeObserver, removeObservers

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

commitTransaction, doPartition, getReferenceService, getRelatedObjectsForPartition, startTransaction

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

invoke

Constructor Detail

DbImportBase

public DbImportBase(java.lang.String tableName,
                    java.lang.String pluralString)

Method Detail

doInvoke

protected void doInvoke(STATE state)

Description copied from class: CdmIoBase

invoke method to be implemented by implementing classes

Specified by:

doInvoke in class CdmIoBase<STATE extends DbImportStateBase<CONFIG,STATE>,ImportResult>

getRecordQuery

protected abstract java.lang.String getRecordQuery(CONFIG config)

Returns:

getIdQuery

protected abstract java.lang.String getIdQuery(STATE state)

Returns:

getTableName

protected java.lang.String getTableName()

Returns:

getPluralString

public java.lang.String getPluralString()

Specified by:

getPluralString in interface IPartitionedIO<STATE extends DbImportStateBase<CONFIG,STATE>>

doId

protected boolean doId(STATE state,
                       ISourceable sourceable,
                       long id,
                       java.lang.String namespace)

Parameters:

state -

sourceable -

id -

namespace -

Returns:

doId

protected boolean doId(STATE state,
                       ISourceable sourceable,
                       java.lang.String id,
                       java.lang.String namespace)

Parameters:

state -

sourceable -

id -

namespace -

Returns:

doNotes

protected Annotation doNotes(AnnotatableEntity annotatableEntity,
                             java.lang.String notes)

Adds a note to the annotatable entity. Nothing happens if annotatableEntity is null or notes is empty or null.

Parameters:

annotatableEntity -

notes -

getUser

protected User getUser(STATE state,
                       java.lang.String userString)

getExistingUser

protected User getExistingUser(STATE state,
                               java.lang.String userString,
                               User user)

Parameters:

state -

userString -

user -

Returns:

resultSetHasColumn

protected boolean resultSetHasColumn(java.sql.ResultSet rs,
                                     java.lang.String columnName)

checkSqlServerColumnExists

protected boolean checkSqlServerColumnExists(Source source,
                                             java.lang.String tableName,
                                             java.lang.String columnName)

getValueMap

protected java.util.Map<java.lang.String,java.lang.Object> getValueMap(java.sql.ResultSet rs)
                                                                throws java.sql.SQLException

Returns a map that holds all values of a ResultSet. This is needed if a value needs to be accessed twice

Parameters:

rs -

Returns:

Throws:

java.sql.SQLException

handleForeignKey

protected void handleForeignKey(java.sql.ResultSet rs,
                                java.util.Set<java.lang.String> idSet,
                                java.lang.String attributeName)
                         throws java.sql.SQLException

Reads a foreign key field from the result set and adds its value to the idSet.

Parameters:

rs -

teamIdSet -

Throws:

java.sql.SQLException

loopNeedsHandling

protected boolean loopNeedsHandling(int i,
                                    int recordsPerLoop)

Returns true if i is a multiple of recordsPerTransaction

Parameters:

i -

recordsPerTransaction -

Returns:

doLogPerLoop

protected void doLogPerLoop(int count,
                            int recordsPerLog,
                            java.lang.String pluralString)