Package adams.flow.control

Class ConditionalTee

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

adams.flow.control.Tee

adams.flow.control.ConditionalTee

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, OutputProducer, SubFlowWrapUp, Serializable, Comparable

public class ConditionalTee
extends Tee
implements BooleanConditionSupporter

Tees off the tokens if the condition evaluates to 'true'.

Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
adams.flow.core.Unknown


Conditional equivalent:
adams.flow.control.ConditionalTee

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

-annotation <adams.core.base.BaseAnnotation> (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
 

-silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 

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

-asynchronous <boolean> (property: asynchronous)
    If enabled, the sub-actors get executed asynchronously rather than the flow 
    waiting for them to finish before proceeding with execution.
    default: false
 

-tee <adams.flow.core.Actor> [-tee ...] (property: actors)
    The actors to siphon-off the tokens to.
    default: 
 

-condition <adams.flow.condition.bool.BooleanCondition> (property: condition)
    The boolean condition to evaluate.
    default: adams.flow.condition.bool.Expression
 

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

AbstractTee.TeeSwingWorker

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanCondition	m_Condition	the condition to use.

Fields inherited from class adams.flow.control.AbstractTee

BACKUP_INPUT, m_Actors, m_Asynchronous, m_AsynchronousWorker, m_InputToken, m_MinimumActiveActors, m_OutputToken

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canFire()	Determines whether the actor can "fire", i.e., outputting a token on the tee-branch.
protected boolean	canProcessInput(Token token)	Returns whether the token can be processed in the tee actor.
String	conditionTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
BooleanCondition	getCondition()	Returns the condition responsible for tee-ing of the token.
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 responsible for tee-ing of the token.
String	setUp()	Initializes the sub-actors for flow execution.
void	stopExecution()	Stops the execution.

Methods inherited from class adams.flow.control.Tee

checkTeeActor, checkTeeActors, getActorHandlerInfo, getConditionalEquivalent, getTimedEquivalent, setUpTeeActors

Methods inherited from class adams.flow.control.AbstractTee

accepts, actorsTipText, add, add, asynchronousTipText, backupState, check, cleanUp, createTeeToken, currentInput, doExecute, execute, finishBeforeStoppingTipText, finishedAsynchronousExecution, flushExecution, forceVariables, generates, get, getActors, getAsynchronous, getFinishBeforeStopping, getInternalActors, getMinimumActiveActors, getStoppingTimeout, hasInput, hasPendingOutput, indexOf, initialize, input, output, processInput, remove, removeAll, restoreState, set, setActors, setAsynchronous, setFinishBeforeStopping, setLoggingLevel, setMinimumActiveActors, setSkip, setStoppingTimeout, setUpSubActors, size, stoppingTimeoutTipText, updateParent, waitForAsynchronousExecution, wrapUp

Methods inherited from class adams.flow.control.AbstractControlActor

active, canInspectOptions, destroy, firstActive, firstInputConsumer, flowPauseStateChanged, isPaused, isSubFlowWrappedUp, lastActive, pauseExecution, preExecute, reset, resumeExecution, setParent, 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, postExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setName, setSilent, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, 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, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.flow.core.ActorHandler

firstActive, 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 to use.

Constructor Detail

ConditionalTee

public ConditionalTee()

Default constructor.

ConditionalTee

public ConditionalTee(String name)

Initializes the actor with the specified name.

Parameters:

name - the name to use

ConditionalTee

public ConditionalTee(String name,
                      BooleanCondition condition)

Initializes the actor with the specified name/condition.

Parameters:

name - the name to use

condition - the condition to use

ConditionalTee

public ConditionalTee(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 Tee

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 AbstractTee

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 AbstractTee

Returns:

null if no info available, otherwise short string

setCondition

public void setCondition(BooleanCondition value)

Sets the condition responsible for tee-ing of the token.

Specified by:

setCondition in interface BooleanConditionSupporter

Parameters:

value - the condition

getCondition

public BooleanCondition getCondition()

Returns the condition responsible for tee-ing of the token.

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.

canFire

protected boolean canFire()

Determines whether the actor can "fire", i.e., outputting a token on the tee-branch.

Returns:

true if it can fire

canProcessInput

protected boolean canProcessInput(Token token)

Returns whether the token can be processed in the tee actor.

Overrides:

canProcessInput in class AbstractTee

Parameters:

token - the token to process

Returns:

true if token can be processed

setUp

public String setUp()

Initializes the sub-actors for flow execution.

Specified by:

setUp in interface Actor

Overrides:

setUp in class AbstractControlActor

Returns:

null if everything is fine, otherwise error message

See Also:

AbstractActor.reset()

stopExecution

public void stopExecution()

Stops the execution.

Specified by:

stopExecution in interface Actor

Specified by:

stopExecution in interface Stoppable

Overrides:

stopExecution in class AbstractTee