Package adams.flow.standalone

Class CallableActors

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.control.AbstractControlActor

adams.flow.control.AbstractDirectedControlActor

adams.flow.control.MutableControlActor

adams.flow.standalone.CallableActors

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Pausable, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, FlowPauseStateListener, VariableChangeListener, AtomicExecution, Actor, ActorHandler, ActorReferenceHandler, ControlActor, ErrorHandler, Flushable, MutableActorHandler, SubFlowWrapUp, Serializable, Comparable

public class CallableActors
extends MutableControlActor
implements ActorReferenceHandler

Container for actors that need to be accessed via their name.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: CallableActors
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 

-stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 

-finish-before-stopping <boolean> (property: finishBeforeStopping)
    If enabled, actor first finishes processing all data before stopping.
    default: false
 

-actor <adams.flow.core.AbstractActor> [-actor ...] (property: actors)
    All the actors that are to be accessed via their name.
    default: 
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CallableActors.CallableActorsDirector	Dummy director.

Field Summary

Fields inherited from class adams.flow.control.MutableControlActor

m_Actors

Fields inherited from class adams.flow.control.AbstractDirectedControlActor

m_Director, m_FinishBeforeStopping, m_StoppingTimeout, m_StoppingWarningInterval

Fields inherited from class adams.flow.control.AbstractControlActor

m_Compatibility, m_PauseStateManager, m_SetUpSubActors

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

Method Summary

Modifier and Type	Method	Description
String	actorsTipText()	Returns the tip text for this property.
String	check()	Checks the names for uniqueness.
String	checkActorReferenceHandlers()	Ensures that the handlers appear in the correct order.
protected String	checkNames()	Checks whether the names of the contained actors are unique or not.
protected String	doExecute()	Does nothing.
ActorHandlerInfo	getActorHandlerInfo()	Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.
Class[]	getProhibitedPrecedingActorReferenceHandlers()	Returns the classes that are prohibited to appear before this reference handler.
String	globalInfo()	Returns a string describing the object.
boolean	isReferencingRequired()	Returns whether actors have to be referenced elsewhere in the flow or whether it is optional.
protected AbstractDirector	newDirector()	Returns an instance of a director.
void	wrapUp()	Finishes up the execution.

Methods inherited from class adams.flow.control.MutableControlActor

add, add, defineOptions, get, getActors, indexOf, initialize, remove, removeAll, set, setActors, size

Methods inherited from class adams.flow.control.AbstractDirectedControlActor

cleanUp, finishBeforeStoppingTipText, flushExecution, getDirector, getFinishBeforeStopping, getQuickInfo, getStoppingTimeout, getStoppingWarningInterval, setFinishBeforeStopping, setStoppingTimeout, setStoppingWarningInterval, setUp, stopExecution, stoppingTimeoutTipText, stoppingWarningIntervalTipText, updateVariables

Methods inherited from class adams.flow.control.AbstractControlActor

active, canInspectOptions, destroy, firstActive, firstInputConsumer, flowPauseStateChanged, forceVariables, isPaused, isSubFlowWrappedUp, lastActive, pauseExecution, preExecute, reset, resumeExecution, setParent, setUpSubActors, updateParent, wrapUpSubFlow

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canPerformSetUpCheck, compareTo, configureLogger, equals, execute, finalUpdateVariables, findVariables, findVariables, 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, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, 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, getQuickInfo, 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

Methods inherited from interface adams.flow.core.ActorHandler

firstActive, flushExecution, get, indexOf, lastActive, set, size

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.flow.core.MutableActorHandler

add, add, remove, removeAll

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Constructor Detail

CallableActors

public CallableActors()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

newDirector

protected AbstractDirector newDirector()

Returns an instance of a director.

Overrides:

newDirector in class AbstractDirectedControlActor

Returns:

the director

actorsTipText

public String actorsTipText()

Returns the tip text for this property.

Specified by:

actorsTipText in class MutableControlActor

Returns:

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

getActorHandlerInfo

public ActorHandlerInfo getActorHandlerInfo()

Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.

Specified by:

getActorHandlerInfo in interface ActorHandler

Specified by:

getActorHandlerInfo in class AbstractControlActor

Returns:

the info

checkNames

protected String checkNames()

Checks whether the names of the contained actors are unique or not.

Returns:

null if names unique, otherwise offending pair

checkActorReferenceHandlers

public String checkActorReferenceHandlers()

Ensures that the handlers appear in the correct order.

Specified by:

checkActorReferenceHandlers in interface ActorReferenceHandler

Returns:

null if OK, otherwise error message

See Also:

getProhibitedPrecedingActorReferenceHandlers()

isReferencingRequired

public boolean isReferencingRequired()

Returns whether actors have to be referenced elsewhere in the flow or whether it is optional.

Specified by:

isReferencingRequired in interface ActorReferenceHandler

Returns:

true if required, false if optional

check

public String check()

Checks the names for uniqueness.

Specified by:

check in interface ActorHandler

Overrides:

check in class AbstractControlActor

Returns:

null if everything is fine, otherwise the offending connection

getProhibitedPrecedingActorReferenceHandlers

public Class[] getProhibitedPrecedingActorReferenceHandlers()

Returns the classes that are prohibited to appear before this reference handler.

Specified by:

getProhibitedPrecedingActorReferenceHandlers in interface ActorReferenceHandler

Returns:

the classes

doExecute

protected String doExecute()

Does nothing.

Overrides:

doExecute in class AbstractDirectedControlActor

Returns:

null

wrapUp

public void wrapUp()

Finishes up the execution.

Specified by:

wrapUp in interface Actor

Overrides:

wrapUp in class AbstractDirectedControlActor