Package adams.flow.source

Class SwitchedSource

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.source.AbstractSource

adams.flow.source.SwitchedSource

All Implemented Interfaces:

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

public class SwitchedSource
extends AbstractSource
implements MutableActorHandler, IndexedBooleanConditionSupporter

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Actor	m_ActiveCase	the active case.
protected List<Actor>	m_Cases	the "cases" to execute if the corresponding expression matches.
protected BooleanCondition[]	m_Conditions	the "conditions" for the various switch cases.

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

Method Summary

Modifier and Type	Method	Description
String	add(int index, Actor actor)	Inserts the actor at the given position.
String	add(Actor actor)	Inserts the actor at the end.
String	casesTipText()	Returns the tip text for this property.
String	check()	Performs checks on the "sub-actors".
String	check(int index, Actor actor)	Performs checks on the "sub-actor".
String	conditionsTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
Actor	firstActive()	Returns the first non-skipped actor.
void	flushExecution()	Stops the processing of tokens without stopping the flow.
protected void	forceVariables(Variables value)	Updates the Variables instance in use.
Class[]	generates()	Returns the class of objects that it generates.
Actor	get(int index)	Returns the actor at the given position.
ActorHandlerInfo	getActorHandlerInfo()	Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.
Actor[]	getCases()	Returns the cases.
BooleanCondition[]	getConditions()	Returns the conditions to evaluate.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
boolean	hasPendingOutput()	Checks whether there is pending output to be collected after executing the flow item.
int	indexOf(String actor)	Returns the index of the actor.
protected void	initialize()	Initializes the members.
Actor	lastActive()	Returns the last non-skipped actor.
Token	output()	Returns the generated token.
Actor	remove(int index)	Removes the actor at the given position and returns the removed object.
void	removeAll()	Removes all actors.
protected void	reset()	Resets the actor.
String	set(int index, Actor actor)	Sets the actor at the given position.
void	setCases(Actor[] value)	Sets the cases.
void	setConditions(BooleanCondition[] value)	Sets the conditions to evaluate.
String	setUp()	Initializes the sub-actors for flow execution.
int	size()	Returns the size of the group.
void	stopExecution()	Stops the execution.
boolean	supports(BooleanCondition condition)	Returns whether the condition is supported.
protected void	updateParent()	Updates the parent of all actors in this group.
protected int	whichCase()	Determines which case to execute.

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, 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, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, 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, 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.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_Conditions

protected BooleanCondition[] m_Conditions

the "conditions" for the various switch cases.

m_Cases

protected List<Actor> m_Cases

the "cases" to execute if the corresponding expression matches.

m_ActiveCase

protected Actor m_ActiveCase

the active case.

Constructor Detail

SwitchedSource

public SwitchedSource()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActor

reset

protected void reset()

Resets the actor.

Overrides:

reset in class AbstractActor

setConditions

public void setConditions(BooleanCondition[] value)

Sets the conditions to evaluate.

Parameters:

value - the conditions

getConditions

public BooleanCondition[] getConditions()

Returns the conditions to evaluate.

Returns:

the conditions

conditionsTipText

public String conditionsTipText()

Returns the tip text for this property.

Returns:

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

setCases

public void setCases(Actor[] value)

Sets the cases.

Parameters:

value - the cases

getCases

public Actor[] getCases()

Returns the cases.

Returns:

the cases

casesTipText

public String casesTipText()

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 AbstractActor

Returns:

null if no info available, otherwise short string

size

public int size()

Returns the size of the group.

Specified by:

size in interface ActorHandler

Returns:

the number of cases

get

public Actor get(int index)

Returns the actor at the given position.

Specified by:

get in interface ActorHandler

Parameters:

index - the position

Returns:

the actor

updateParent

protected void updateParent()

Updates the parent of all actors in this group.

set

public String set(int index,
                  Actor actor)

Sets the actor at the given position.

Specified by:

set in interface ActorHandler

Parameters:

index - the position

actor - the actor to set at this position

Returns:

null if successful, otherwise error message

add

public String add(Actor actor)

Inserts the actor at the end.

Specified by:

add in interface MutableActorHandler

Parameters:

actor - the actor to insert

Returns:

null if successful, otherwise error message

add

public String add(int index,
                  Actor actor)

Inserts the actor at the given position.

Specified by:

add in interface MutableActorHandler

Parameters:

index - the position

actor - the actor to insert

Returns:

null if successful, otherwise error message

remove

public Actor remove(int index)

Removes the actor at the given position and returns the removed object.

Specified by:

remove in interface MutableActorHandler

Parameters:

index - the position

Returns:

the removed actor

removeAll

public void removeAll()

Removes all actors.

Specified by:

removeAll in interface MutableActorHandler

indexOf

public int indexOf(String actor)

Returns the index of the actor.

Specified by:

indexOf in interface ActorHandler

Parameters:

actor - the name of the actor to look for

Returns:

the index of -1 if not found

firstActive

public Actor firstActive()

Returns the first non-skipped actor.

Specified by:

firstActive in interface ActorHandler

Returns:

the first 'active' actor, null if none available

lastActive

public Actor lastActive()

Returns the last non-skipped actor.

Specified by:

lastActive in interface ActorHandler

Returns:

the last 'active' actor, null if none available

supports

public boolean supports(BooleanCondition condition)

Returns whether the condition is supported.

Specified by:

supports in interface IndexedBooleanConditionSupporter

Returns:

true if supported, false otherwise

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

forceVariables

protected void forceVariables(Variables value)

Updates the Variables instance in use.

Use with caution!

Overrides:

forceVariables in class AbstractActor

Parameters:

value - the instance to use

check

public String check(int index,
                    Actor actor)

Performs checks on the "sub-actor".

Parameters:

index - the index of the actor

actor - the actor to check

Returns:

null if successful passed, otherwise error message

check

public String check()

Performs checks on the "sub-actors".

Specified by:

check in interface ActorHandler

Returns:

null

setUp

public String setUp()

Initializes the sub-actors for flow execution.

Specified by:

setUp in interface Actor

Overrides:

setUp in class AbstractActor

Returns:

null if everything is fine, otherwise error message

See Also:

AbstractActor.reset()

whichCase

protected int whichCase()

Determines which case to execute.

Returns:

the index of the case to execute

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

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

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

output

public Token output()

Returns the generated token.

Specified by:

output in interface OutputProducer

Returns:

the generated token

flushExecution

public void flushExecution()

Stops the processing of tokens without stopping the flow.

Specified by:

flushExecution in interface ActorHandler

Specified by:

flushExecution in interface Flushable

stopExecution

public void stopExecution()

Stops the execution.

Specified by:

stopExecution in interface Actor

Specified by:

stopExecution in interface Stoppable

Overrides:

stopExecution in class AbstractActor