Package adams.flow.transformer

Class ConditionalTransformer

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.transformer.ConditionalTransformer

All Implemented Interfaces:

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

public class ConditionalTransformer
extends AbstractConditionalActor
implements InputConsumer, OutputProducer

Transformer that needs to fullfil a condition before being executed.

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

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

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

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

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

-actor <adams.flow.core.Actor [options]> (property: actor)
    The base transformer to use.
    default: adams.flow.transformer.PassThrough
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	BACKUP_INPUT	the key for storing the current input token in the backup.
protected Token	m_InputToken	the current token to process.

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

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
String	actorTipText()	Returns the tip text for this property.
protected Hashtable<String,Object>	backupState()	Backs up the current state of the actor before update the variables.
Token	currentInput()	Returns the current input token, if any.
Class[]	generates()	Returns the class of objects that it generates.
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.
boolean	hasInput()	Returns whether an input token is currently present.
boolean	hasPendingOutput()	Checks whether there is pending output to be collected after executing the flow item.
void	input(Token token)	The method that accepts the input token and then processes it.
Token	output()	Returns the generated token.
protected String	preExecute()	Pre-execute hook.
protected void	restoreState(Hashtable<String,Object> state)	Restores the state of the actor before the variables got updated.
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, reset, set, setActor, setCheckAtExecutionTime, setCondition, setExecuteOnFail, size, updateParent

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, 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, 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

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, 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, defineOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

BACKUP_INPUT

public static final String BACKUP_INPUT

the key for storing the current input token in the backup.

See Also:

Constant Field Values

m_InputToken

protected transient Token m_InputToken

the current token to process.

Constructor Detail

ConditionalTransformer

public ConditionalTransformer()

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.

Specified by:

getActorHandlerInfo in interface ActorHandler

Returns:

the info

backupState

protected Hashtable<String,Object> backupState()

Backs up the current state of the actor before update the variables.

Overrides:

backupState in class AbstractActor

Returns:

the backup

See Also:

AbstractActor.updateVariables(), AbstractActor.restoreState(Hashtable)

restoreState

protected void restoreState(Hashtable<String,Object> state)

Restores the state of the actor before the variables got updated.

Overrides:

restoreState in class AbstractActor

Parameters:

state - the backup of the state to restore from

See Also:

AbstractActor.updateVariables(), AbstractActor.backupState()

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

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Returns:

the Class of objects that can be processed

input

public void input(Token token)

The method that accepts the input token and then processes it.

Specified by:

input in interface InputConsumer

Parameters:

token - the token to accept and process

hasInput

public boolean hasInput()

Returns whether an input token is currently present.

Specified by:

hasInput in interface InputConsumer

Returns:

true if input token present

currentInput

public Token currentInput()

Returns the current input token, if any.

Specified by:

currentInput in interface InputConsumer

Returns:

the input token, null if none present

generates

public Class[] generates()

Returns the class of objects that it generates.

Specified by:

generates in interface OutputProducer

Returns:

the Class of the generated tokens

preExecute

protected String preExecute()

Pre-execute hook.

Overrides:

preExecute in class AbstractConditionalActor

Returns:

null if everything is fine, otherwise error message

output

public Token output()

Returns the generated token.

Specified by:

output in interface OutputProducer

Returns:

the generated token

hasPendingOutput

public boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

Specified by:

hasPendingOutput in interface OutputProducer

Returns:

true if there is pending output