Package adams.flow.control

Class AbstractConnectedControlActor

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.AbstractConnectedControlActor

All Implemented Interfaces:

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

Direct Known Subclasses:

MutableConnectedControlActor

public abstract class AbstractConnectedControlActor
extends AbstractDirectedControlActor

Ancestor for all actors that control (connected) sub-actors in some way.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
String	check()	Performs checks on the "sub-actors".
protected String	checkConnections()	Checks whether all the connections are valid, i.e., the input and output types fit and whether the flow chain is connected properly.
protected String	classesToString(Class[] classes)	Turns the class array into a string.

Methods inherited from class adams.flow.control.AbstractDirectedControlActor

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

Methods inherited from class adams.flow.control.AbstractControlActor

active, canInspectOptions, destroy, firstActive, firstInputConsumer, flowPauseStateChanged, forceVariables, get, getActorHandlerInfo, indexOf, initialize, isPaused, isSubFlowWrappedUp, lastActive, pauseExecution, preExecute, reset, resumeExecution, set, setParent, setUpSubActors, size, 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, 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

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, toCommandLine, variableChanged

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

Constructor Detail

AbstractConnectedControlActor

public AbstractConnectedControlActor()

Method Detail

classesToString

protected String classesToString(Class[] classes)

Turns the class array into a string.

Parameters:

classes - the classes to turn into a string

Returns:

the generated string

checkConnections

protected String checkConnections()

Checks whether all the connections are valid, i.e., the input and output types fit and whether the flow chain is connected properly.

Returns:

null if everything is fine, otherwise the offending connection

check

public String check()

Performs checks on the "sub-actors".

Specified by:

check in interface ActorHandler

Overrides:

check in class AbstractControlActor

Returns:

null