Package adams.flow.source

Class AbstractConditionalIdSupplier

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.source.AbstractSource

adams.flow.source.AbstractArrayProvider

adams.flow.source.AbstractIdSupplier

adams.flow.source.AbstractDatabaseIdSupplier

adams.flow.source.AbstractConditionalIdSupplier

All Implemented Interfaces:

AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LenientModeSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, DatabaseConnectionUser, VariableChangeListener, Actor, ArrayProvider, ErrorHandler, OutputProducer, ConditionalIdSupplier, Serializable, Comparable

public abstract class AbstractConditionalIdSupplier
extends AbstractDatabaseIdSupplier
implements ConditionalIdSupplier

Abstract ancestor for ID suppliers that use a conditions object.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractConditions	m_Conditions	the retrieval conditions.

Fields inherited from class adams.flow.source.AbstractDatabaseIdSupplier

m_DatabaseConnection

Fields inherited from class adams.flow.source.AbstractIdSupplier

m_Lenient

Fields inherited from class adams.flow.source.AbstractArrayProvider

m_Index, m_OutputArray, m_Queue

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors

Constructor	Description
AbstractConditionalIdSupplier()

Method Summary

Modifier and Type	Method	Description
String	conditionsTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Class[]	getAcceptedConditions()	Returns the accepted classes for condition objects.
AbstractConditions	getConditions()	Returns the conditions container to use for retrieving the spectra.
protected abstract AbstractConditions	getDefaultConditions()	Returns the default conditions.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
void	setConditions(AbstractConditions value)	Sets the conditions container to use for retrieving the spectra.

Methods inherited from class adams.flow.source.AbstractDatabaseIdSupplier

doExecute, getDatabaseConnection, getItemClass, initialize, outputArrayTipText, setUpDatabaseConnection, wrapUp

Methods inherited from class adams.flow.source.AbstractIdSupplier

getIDs, getLenient, lenientTipText, setLenient

Methods inherited from class adams.flow.source.AbstractArrayProvider

generates, getOutputArray, hasPendingOutput, output, preExecute, reset, setOutputArray

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_Conditions

protected AbstractConditions m_Conditions

the retrieval conditions.

Constructor Detail

AbstractConditionalIdSupplier

public AbstractConditionalIdSupplier()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractIdSupplier

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractIdSupplier

Returns:

null if no info available, otherwise short string

getDefaultConditions

protected abstract AbstractConditions getDefaultConditions()

Returns the default conditions.

Returns:

the default conditions

getAcceptedConditions

protected Class[] getAcceptedConditions()

Returns the accepted classes for condition objects.

The default implementation just returns the class of the default condition object.

Returns:

the accepted classes

See Also:

getDefaultConditions()

setConditions

public void setConditions(AbstractConditions value)

Sets the conditions container to use for retrieving the spectra.

Specified by:

setConditions in interface ConditionalIdSupplier

Parameters:

value - the conditions

getConditions

public AbstractConditions getConditions()

Returns the conditions container to use for retrieving the spectra.

Specified by:

getConditions in interface ConditionalIdSupplier

Returns:

the conditions

conditionsTipText

public String conditionsTipText()

Returns the tip text for this property.

Specified by:

conditionsTipText in interface ConditionalIdSupplier

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.