Package adams.flow.core

Class AbstractCopyCallableActor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.core.AbstractCopyCallableActor

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, FlowStructureModifier, Actor, ErrorHandler, OptionalCallableActor, Serializable, Comparable

Direct Known Subclasses:

CopyCallableSink, CopyCallableSource, CopyCallableStandalone, CopyCallableTransformer

public abstract class AbstractCopyCallableActor
extends AbstractActor
implements FlowStructureModifier, OptionalCallableActor

Ancestor for actors that use a copy of a callable actor.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CallableActorReference	m_CallableName	the callable name.
protected CallableActorHelper	m_Helper	the helper class.
protected boolean	m_Optional	whether the callable actor is optional.

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
AbstractCopyCallableActor()

Method Summary

Modifier and Type	Method	Description
String	callableNameTipText()	Returns the tip text for this property.
protected abstract String	checkCallableActor(Actor actor)	Performs checks on the callable actor.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
protected Actor	findCallableActor()	Tries to find the callable actor referenced by its name.
CallableActorReference	getCallableName()	Returns the name of the callable actor in use.
protected abstract Actor	getDefaultActor()	Returns the default actor if the callable actor is optional and not found.
boolean	getOptional()	Returns whether the callable actor is optional.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
protected void	initialize()	Initializes the members.
boolean	isModifyingStructure()	Returns whether the actor is modifying the structure.
String	optionalTipText()	Returns the tip text for this property.
void	setCallableName(CallableActorReference value)	Sets the name of the callable actor to use.
void	setOptional(boolean value)	Sets whether the callable actor is optional.
String	setUp()	Initializes the item for flow execution.
protected String	setUpCallableActor()	Configures the callable actor.

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, preExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

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, 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_CallableName

protected CallableActorReference m_CallableName

the callable name.

m_Helper

protected CallableActorHelper m_Helper

the helper class.

m_Optional

protected boolean m_Optional

whether the callable actor is optional.

Constructor Detail

AbstractCopyCallableActor

public AbstractCopyCallableActor()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActor

setCallableName

public void setCallableName(CallableActorReference value)

Sets the name of the callable actor to use.

Parameters:

value - the callable name

getCallableName

public CallableActorReference getCallableName()

Returns the name of the callable actor in use.

Returns:

the callable name

callableNameTipText

public String callableNameTipText()

Returns the tip text for this property.

Returns:

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

setOptional

public void setOptional(boolean value)

Sets whether the callable actor is optional.

Specified by:

setOptional in interface OptionalCallableActor

Parameters:

value - true if optional

getOptional

public boolean getOptional()

Returns whether the callable actor is optional.

Specified by:

getOptional in interface OptionalCallableActor

Returns:

true if optional

optionalTipText

public String optionalTipText()

Returns the tip text for this property.

Specified by:

optionalTipText in interface OptionalCallableActor

Returns:

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

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 AbstractActor

Returns:

null if no info available, otherwise short string

findCallableActor

protected Actor findCallableActor()

Tries to find the callable actor referenced by its name.

Returns:

the callable actor or null if not found

isModifyingStructure

public boolean isModifyingStructure()

Returns whether the actor is modifying the structure.

Specified by:

isModifyingStructure in interface FlowStructureModifier

Returns:

true if the actor is modifying the structure

checkCallableActor

protected abstract String checkCallableActor(Actor actor)

Performs checks on the callable actor.

Parameters:

actor - the actor to check

Returns:

null if OK, otherwise error message

getDefaultActor

protected abstract Actor getDefaultActor()

Returns the default actor if the callable actor is optional and not found.

Returns:

the default

setUpCallableActor

protected String setUpCallableActor()

Configures the callable actor.

Returns:

null if OK, otherwise error message

setUp

public String setUp()

Initializes the item for flow execution.

Specified by:

setUp in interface Actor

Overrides:

setUp in class AbstractActor

Returns:

null if everything is fine, otherwise error message

See Also:

AbstractActor.reset()

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message