Package adams.flow.standalone

Class ConditionalStandalone

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.control.AbstractConditionalActor

adams.flow.standalone.ConditionalStandalone

All Implemented Interfaces:

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

public class ConditionalStandalone
extends AbstractConditionalActor

Standalone that needs to fullfil a condition before being executed.

-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: ConditionalStandalone
 

-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
 

-condition <adams.flow.condition.test.TestCondition> (property: condition)
    The condition that has to be met before the actor can be executed.
    default: adams.flow.condition.test.True
 

-execution-time <boolean> (property: checkAtExecutionTime)
    If set to true, then the condition is checked at execution time (whenever 
    the actor gets executed) and not during setup.
    default: false
 

-execute-on-fail <boolean> (property: executeOnFail)
    If set to true, then the actor is only executed if the condition fails.
    default: false
 

-actor <adams.flow.core.AbstractActor> (property: actor)
    The base standalone to use.
    default: adams.flow.standalone.CallableActors
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.control.AbstractConditionalActor

m_BaseActor, m_BaseActorInitialized, m_CheckAtExecutionTime, m_Condition, m_ExecuteOnFail

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

Method Summary

Modifier and Type	Method	Description
String	actorTipText()	Returns the tip text for this property.
ActorHandlerInfo	getActorHandlerInfo()	Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.
protected Actor	getDefaultActor()	Returns the default actor to use.
String	globalInfo()	Returns a string describing the object.
String	setUp()	Initializes the item for flow execution.

Methods inherited from class adams.flow.control.AbstractConditionalActor

canInspectOptions, check, checkAtExecutionTimeTipText, cleanUp, conditionTipText, defineOptions, doExecute, executeOnFailTipText, firstActive, flushExecution, forceVariables, get, getActor, getCheckAtExecutionTime, getCondition, getExecuteOnFail, getQuickInfo, indexOf, lastActive, preExecute, reset, set, setActor, setCheckAtExecutionTime, setCondition, setExecuteOnFail, size, updateParent

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canPerformSetUpCheck, compareTo, configureLogger, destroy, 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, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, 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, 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, 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

Constructor Detail

ConditionalStandalone

public ConditionalStandalone()

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

getDefaultActor

protected Actor getDefaultActor()

Returns the default actor to use.

Specified by:

getDefaultActor in class AbstractConditionalActor

Returns:

the default actor

actorTipText

public String actorTipText()

Returns the tip text for this property.

Specified by:

actorTipText in class AbstractConditionalActor

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.

Returns:

the info

setUp

public String setUp()

Initializes the item for flow execution.

Specified by:

setUp in interface Actor

Overrides:

setUp in class AbstractConditionalActor

Returns:

null if everything is fine, otherwise error message

See Also:

AbstractActor.reset()