eu.etaxonomy.cdm.io.common

Class CdmIoBase<STATE extends IoStateBase,RESULT extends IoResultBase>

java.lang.Object

eu.etaxonomy.cdm.api.application.CdmRepository

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CdmExportBase, CdmImportBase, SDDIoBase

public abstract class CdmIoBase<STATE extends IoStateBase,RESULT extends IoResultBase>
extends CdmRepository
implements ICdmIO<STATE>, IIoObservable

Since:

01.07.2008

Author:

a.mueller

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	INCLUDE_UNPUBLISHED
protected java.lang.String	ioName
static boolean	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

Modifier	Constructor and Description
protected	CdmIoBase()

Method Summary

Modifier and Type	Method and Description
boolean	addObserver(IIoObserver observer) Adds a new observer for this object.
void	addObservers(java.util.Set<IIoObserver> newObservers) Adds a set of new observer for this object.
boolean	check(STATE state)
void	commitTransaction(org.springframework.transaction.TransactionStatus txStatus)
int	countObservers() Returns the number of observers of this Observable object.
long	countSteps(STATE state)
protected abstract boolean	doCheck(STATE state)
protected abstract void	doInvoke(STATE state) invoke method to be implemented by implementing classes
void	fire(IIoEvent event) If this object fires an event then notify all of its observers.
protected void	fireProgressEvent(java.lang.String message, java.lang.String location)
protected void	fireWarningEvent(java.lang.String message, java.lang.String dataLocation, java.lang.Integer severity)
protected void	fireWarningEvent(java.lang.String message, java.lang.String dataLocation, java.lang.Integer severity, int stackDepth)
protected abstract RESULT	getDefaultResult(STATE state)
protected <T extends CdmBase> T	getInstance(java.lang.Class<? extends T> clazz)
protected abstract RESULT	getNoDataResult(STATE state)
java.util.Set<IIoObserver>	getObservers() Sets the observers for this object
protected java.lang.String	getSuccessString(boolean success)
void	invoke(STATE state)
protected static boolean	isBlank(java.lang.String str)
protected abstract boolean	isIgnore(STATE state) Returns true if this (IO-)class should be ignored during the import/export process.
protected static boolean	isNotBlank(java.lang.String str)
boolean	removeObserver(IIoObserver observer) Removes an observer from this object
void	removeObservers() Clears the observer list so that this object no longer has any observers.
void	rollbackTransaction(org.springframework.transaction.TransactionStatus txStatus)
org.springframework.transaction.TransactionStatus	startTransaction() Starts a read only transaction
org.springframework.transaction.TransactionStatus	startTransaction(java.lang.Boolean readOnly)
void	updateProgress(STATE state, java.lang.String message)
void	updateProgress(STATE state, java.lang.String message, int worked)
void	warnProgress(STATE state, java.lang.String message, java.lang.Throwable e)

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

Field Detail

ioName

protected java.lang.String ioName

NO_UNPUBLISHED

public static final boolean NO_UNPUBLISHED

See Also:

Constant Field Values

INCLUDE_UNPUBLISHED

public static final boolean INCLUDE_UNPUBLISHED

See Also:

Constant Field Values

Constructor Detail

CdmIoBase

protected CdmIoBase()

Method Detail

addObserver

public boolean addObserver(IIoObserver observer)

Description copied from interface: IIoObservable

Adds a new observer for this object.

Specified by:

addObserver in interface IIoObservable

Returns:

getObservers

public java.util.Set<IIoObserver> getObservers()

Description copied from interface: IIoObservable

Sets the observers for this object

Specified by:

getObservers in interface IIoObservable

Returns:

addObservers

public void addObservers(java.util.Set<IIoObserver> newObservers)

Description copied from interface: IIoObservable

Adds a set of new observer for this object.

Specified by:

addObservers in interface IIoObservable

countObservers

public int countObservers()

Description copied from interface: IIoObservable

Returns the number of observers of this Observable object.

Specified by:

countObservers in interface IIoObservable

Returns:

number of observers

removeObserver

public boolean removeObserver(IIoObserver observer)

Description copied from interface: IIoObservable

Removes an observer from this object

Specified by:

removeObserver in interface IIoObservable

Returns:

removeObservers

public void removeObservers()

Description copied from interface: IIoObservable

Clears the observer list so that this object no longer has any observers.

Specified by:

removeObservers in interface IIoObservable

fire

public void fire(IIoEvent event)

Description copied from interface: ICdmIO

If this object fires an event then notify all of its observers.

Specified by:

fire in interface ICdmIO<STATE extends IoStateBase>

invoke

public void invoke(STATE state)

getNoDataResult

protected abstract RESULT getNoDataResult(STATE state)

getDefaultResult

protected abstract RESULT getDefaultResult(STATE state)

countSteps

public long countSteps(STATE state)

Specified by:

countSteps in interface ICdmIO<STATE extends IoStateBase>

startTransaction

public org.springframework.transaction.TransactionStatus startTransaction()

Description copied from interface: ICdmRepository

Starts a read only transaction

Specified by:

startTransaction in interface ICdmRepository

Overrides:

startTransaction in class CdmRepository

startTransaction

public org.springframework.transaction.TransactionStatus startTransaction(java.lang.Boolean readOnly)

Specified by:

startTransaction in interface ICdmRepository

Overrides:

startTransaction in class CdmRepository

commitTransaction

public void commitTransaction(org.springframework.transaction.TransactionStatus txStatus)

Specified by:

commitTransaction in interface ICdmRepository

Overrides:

commitTransaction in class CdmRepository

rollbackTransaction

public void rollbackTransaction(org.springframework.transaction.TransactionStatus txStatus)

Specified by:

rollbackTransaction in interface ICdmRepository

Overrides:

rollbackTransaction in class CdmRepository

check

public boolean check(STATE state)

Specified by:

check in interface ICdmIO<STATE extends IoStateBase>

doCheck

protected abstract boolean doCheck(STATE state)

doInvoke

protected abstract void doInvoke(STATE state)

invoke method to be implemented by implementing classes

Parameters:

state -

isIgnore

protected abstract boolean isIgnore(STATE state)

Returns true if this (IO-)class should be ignored during the import/export process. This information is usually stored in the configuration

Parameters:

config -

Returns:

getInstance

protected <T extends CdmBase> T getInstance(java.lang.Class<? extends T> clazz)

getSuccessString

protected java.lang.String getSuccessString(boolean success)

updateProgress

public void updateProgress(STATE state,
                           java.lang.String message)

Specified by:

updateProgress in interface ICdmIO<STATE extends IoStateBase>

updateProgress

public void updateProgress(STATE state,
                           java.lang.String message,
                           int worked)

Specified by:

updateProgress in interface ICdmIO<STATE extends IoStateBase>

warnProgress

public void warnProgress(STATE state,
                         java.lang.String message,
                         java.lang.Throwable e)

Specified by:

warnProgress in interface ICdmIO<STATE extends IoStateBase>

fireProgressEvent

protected void fireProgressEvent(java.lang.String message,
                                 java.lang.String location)

fireWarningEvent

protected void fireWarningEvent(java.lang.String message,
                                java.lang.String dataLocation,
                                java.lang.Integer severity)

fireWarningEvent

protected void fireWarningEvent(java.lang.String message,
                                java.lang.String dataLocation,
                                java.lang.Integer severity,
                                int stackDepth)

isBlank

protected static boolean isBlank(java.lang.String str)

isNotBlank

protected static boolean isNotBlank(java.lang.String str)