Package adams.flow.control

Class ConditionalSubProcess

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

adams.flow.control.MutableConnectedControlActor

adams.flow.control.Sequence

adams.flow.control.SubProcess

adams.flow.control.ConditionalSubProcess

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Pausable, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, FlowPauseStateListener, VariableChangeListener, BooleanConditionSupporter, AtomicExecution, Actor, ActorHandler, ActorWithConditionalEquivalent, ActorWithTimedEquivalent, ControlActor, ErrorHandler, Flushable, InputConsumer, MutableActorHandler, OptionalStopRestrictor, OutputProducer, PauseStateHandler, StopRestrictor, SubFlowWrapUp, Serializable, Comparable

public class ConditionalSubProcess
extends SubProcess
implements BooleanConditionSupporter

Encapsulates a sequence of flow items. The first actor must accept input and the last one must produce output. But the sequence gets only executed if the condition holds true.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

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

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

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

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

-actor <adams.flow.core.AbstractActor> [-actor ...] (property: actors)
    All the actors that define this sequence.
    default: 
 

-condition <adams.flow.condition.bool.BooleanCondition> (property: condition)
    The condition to evaluate - only as long as it evaluates to 'true' the loop 
    actors get executed.
    default: adams.flow.condition.bool.Expression
 

-drop-tokens-on-condition-fail (property: dropTokensOnConditionFail)
    If enabled, any incoming tokens that weren't processed due to the condition 
    evaluating to false will get dropped and not forwarded.
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.flow.control.SubProcess

SubProcess.SubProcessDirector

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanCondition	m_Condition	the condition that determines the execution of the subprocess items.
protected boolean	m_DropTokensOnConditionFail	whether to drop tokens when condition didn't hold true.

Fields inherited from class adams.flow.control.SubProcess

m_AllowEmpty, m_OutputTokens

Fields inherited from class adams.flow.control.Sequence

BACKUP_CURRENT, m_AllowSource, m_AllowStandalones, m_CurrentToken, m_RestrictedStop, m_RestrictingStops

Fields inherited from class adams.flow.control.MutableConnectedControlActor

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
ConditionalSubProcess()	Default constructor.
ConditionalSubProcess(BooleanCondition condition)	Initializes the actor with the specified condition.
ConditionalSubProcess(String name)	Initializes the actor with the specified name.
ConditionalSubProcess(String name, BooleanCondition condition)	Initializes the actor with the specified name/condition.

Method Summary

Modifier and Type	Method	Description
String	conditionTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the actor.
String	dropTokensOnConditionFailTipText()	Returns the tip text for this property.
BooleanCondition	getCondition()	Returns the condtion to evaluate.
boolean	getDropTokensOnConditionFail()	Returns whether to drop incoming tokens if condition evaluates to false instead of forwarding them.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setCondition(BooleanCondition value)	Sets the condition to evaluate.
void	setDropTokensOnConditionFail(boolean value)	Sets whether to drop incoming tokens if condition evaluates to false instead of forwarding them.
String	setUp()	Initializes the sub-actors for flow execution.
void	stopExecution()	Stops the execution.

Methods inherited from class adams.flow.control.SubProcess

accepts, addOutputToken, cleanUp, execute, generates, getAllowEmpty, getConditionalEquivalent, getOutputTokens, getPauseStateManager, getTimedEquivalent, hasPendingOutput, initialize, input, newDirector, output, setAllowEmpty

Methods inherited from class adams.flow.control.Sequence

actorsTipText, backupState, currentInput, getActorHandlerInfo, getAllowSource, getAllowStandalones, getDefaultRestrictingStops, hasInput, isRestrictedStop, isRestrictingStops, postExecute, preExecute, restoreState, restrictedStopExecution, restrictedStopExecution, setAllowSource, setAllowStandalones, setRestrictingStops, wrapUp

Methods inherited from class adams.flow.control.MutableConnectedControlActor

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

Methods inherited from class adams.flow.control.AbstractConnectedControlActor

check, checkConnections, classesToString

Methods inherited from class adams.flow.control.AbstractDirectedControlActor

finishBeforeStoppingTipText, flushExecution, getDirector, getFinishBeforeStopping, getStoppingTimeout, getStoppingWarningInterval, setFinishBeforeStopping, setStoppingTimeout, setStoppingWarningInterval, stoppingTimeoutTipText, stoppingWarningIntervalTipText, updateVariables

Methods inherited from class adams.flow.control.AbstractControlActor

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

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canPerformSetUpCheck, compareTo, configureLogger, equals, 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, pruneBackup, pruneBackup, 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

compareTo, destroy, equals, 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, wrapUp

Methods inherited from interface adams.flow.core.ActorHandler

check, firstActive, flushExecution, lastActive

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_Condition

protected BooleanCondition m_Condition

the condition that determines the execution of the subprocess items.

m_DropTokensOnConditionFail

protected boolean m_DropTokensOnConditionFail

whether to drop tokens when condition didn't hold true.

Constructor Detail

ConditionalSubProcess

public ConditionalSubProcess()

Default constructor.

ConditionalSubProcess

public ConditionalSubProcess(String name)

Initializes the actor with the specified name.

Parameters:

name - the name to use

ConditionalSubProcess

public ConditionalSubProcess(String name,
                             BooleanCondition condition)

Initializes the actor with the specified name/condition.

Parameters:

name - the name to use

condition - the condition to use

ConditionalSubProcess

public ConditionalSubProcess(BooleanCondition condition)

Initializes the actor with the specified condition.

Parameters:

condition - the condition to use

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Overrides:

globalInfo in class SubProcess

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class MutableConnectedControlActor

setCondition

public void setCondition(BooleanCondition value)

Sets the condition to evaluate.

Specified by:

setCondition in interface BooleanConditionSupporter

Parameters:

value - the condition

getCondition

public BooleanCondition getCondition()

Returns the condtion to evaluate.

Specified by:

getCondition in interface BooleanConditionSupporter

Returns:

the condition

conditionTipText

public String conditionTipText()

Returns the tip text for this property.

Returns:

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

setDropTokensOnConditionFail

public void setDropTokensOnConditionFail(boolean value)

Sets whether to drop incoming tokens if condition evaluates to false instead of forwarding them.

Parameters:

value - if true tokens get dropped if evaluation evaluates to false

getDropTokensOnConditionFail

public boolean getDropTokensOnConditionFail()

Returns whether to drop incoming tokens if condition evaluates to false instead of forwarding them.

Returns:

true if to drop tokens when condition evaluates to false

dropTokensOnConditionFailTipText

public String dropTokensOnConditionFailTipText()

Returns the tip text for this property.

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 AbstractDirectedControlActor

Returns:

null if no info available, otherwise short string

setUp

public String setUp()

Initializes the sub-actors for flow execution.

Specified by:

setUp in interface Actor

Overrides:

setUp in class SubProcess

Returns:

null if everything is fine, otherwise error message

See Also:

AbstractActor.reset()

doExecute

protected String doExecute()

Executes the actor.

Overrides:

doExecute in class AbstractDirectedControlActor

Returns:

null if everything is fine, otherwise error message

stopExecution

public void stopExecution()

Stops the execution.

Specified by:

stopExecution in interface Actor

Specified by:

stopExecution in interface Stoppable

Overrides:

stopExecution in class AbstractDirectedControlActor