Package adams.flow.standalone

Class AbstractMutableActorDaemonEvent<E,P>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.standalone.AbstractStandalone

adams.flow.standalone.AbstractMutableActorDaemonEvent<E,P>

Type Parameters:

E - the type of event

P - the type of the processed event

All Implemented Interfaces:

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

Direct Known Subclasses:

DirWatch, LogEvent, VariableChangedEvent

public abstract class AbstractMutableActorDaemonEvent<E,P>
extends AbstractStandalone
implements MutableActorHandler, DaemonEvent

Ancestor for daemon events that handle sub-actors.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	BUSY	the result if actors are currently being executed.
protected Sequence	m_Actors	for actors that get executed.
protected boolean	m_ExecutingActors	whether the actors are currently being executed.
protected boolean	m_NoDiscard	whether to discard change events when busy or not.
static String	NO_OUTPUT	the result preprocessing didn't generate any output.

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

Method Summary

Modifier and Type	Method	Description
int	active()	Returns the number of non-skipped actors.
String	actorsTipText()	Returns the tip text for this property.
String	add(int index, Actor actor)	Inserts the actor at the given position.
String	add(Actor actor)	Inserts the actor at the end.
String	check()	Performs checks on the "sub-actors".
protected abstract String	checkActors(Actor[] actors)	Checks the actors before they are set via the setActors method.
void	cleanUp()	Cleans up after the execution has finished.
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.
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[]	getActors()	Returns the actors to execute on schedule.
boolean	getNoDiscard()	Returns whether to process all change events or discard if busy.
protected abstract boolean	handlesEvent(E e)	Checks whether the event is being handled.
int	indexOf(String actor)	Returns the index of the actor.
protected void	initialize()	Initializes the members.
Actor	lastActive()	Returns the last non-skipped actor.
String	noDiscardTipText()	Returns the tip text for this property.
protected abstract P	preProcessEvent(E e)	Preprocesses the event.
protected String	processEvent(E e)	Processes the event.
Actor	remove(int index)	Removes the actor at the given position and returns the removed object.
void	removeAll()	Removes all actors.
String	set(int index, Actor actor)	Sets the actor at the given position.
void	setActors(Actor[] value)	Sets the actors to execute on schedule.
void	setLoggingLevel(LoggingLevel value)	Sets the logging level.
void	setNoDiscard(boolean value)	Sets whether to process all change events or discard if busy.
String	setUp()	Initializes the sub-actors for flow execution.
int	size()	Returns the size of the group.
void	stopExecution()	Stops the execution.
protected void	updateParent()	Updates the parent of all actors in this group.
protected abstract boolean	usePreProcessedAsInput()	Returns whether the preprocessed event is used as input token.
void	wrapUp()	Cleans up after the execution has finished.

Methods inherited from class adams.flow.standalone.AbstractStandalone

preExecute

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, 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, getQuickInfo, 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, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, 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, globalInfo, 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

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, toCommandLine, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

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

BUSY

public static final String BUSY

the result if actors are currently being executed.

See Also:

Constant Field Values

NO_OUTPUT

public static final String NO_OUTPUT

the result preprocessing didn't generate any output.

See Also:

Constant Field Values

m_NoDiscard

protected boolean m_NoDiscard

whether to discard change events when busy or not.

m_Actors

protected Sequence m_Actors

for actors that get executed.

m_ExecutingActors

protected boolean m_ExecutingActors

whether the actors are currently being executed.

Constructor Detail

AbstractMutableActorDaemonEvent

public AbstractMutableActorDaemonEvent()

Method Detail

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

setLoggingLevel

public void setLoggingLevel(LoggingLevel value)

Sets the logging level.

Specified by:

setLoggingLevel in interface LoggingLevelHandler

Overrides:

setLoggingLevel in class AbstractOptionHandler

Parameters:

value - the level

updateParent

protected void updateParent()

Updates the parent of all actors in this group.

setNoDiscard

public void setNoDiscard(boolean value)

Sets whether to process all change events or discard if busy.

Parameters:

value - if true all change events get processed

getNoDiscard

public boolean getNoDiscard()

Returns whether to process all change events or discard if busy.

Returns:

true if all change events get processed

noDiscardTipText

public String noDiscardTipText()

Returns the tip text for this property.

Returns:

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

checkActors

protected abstract String checkActors(Actor[] actors)

Checks the actors before they are set via the setActors method. Returns an error message if the actors are not acceptable, null otherwise.

Parameters:

actors - the actors to check

Returns:

null if accepted, otherwise error message

setActors

public void setActors(Actor[] value)

Sets the actors to execute on schedule.

Parameters:

value - the actors

getActors

public Actor[] getActors()

Returns the actors to execute on schedule.

Returns:

the actors

actorsTipText

public String actorsTipText()

Returns the tip text for this property.

Returns:

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

handlesEvent

protected abstract boolean handlesEvent(E e)

Checks whether the event is being handled.

Parameters:

e - the event to check

Returns:

true if being handled

preProcessEvent

protected abstract P preProcessEvent(E e)

Preprocesses the event.

Parameters:

e - the event to preprocess

Returns:

the output of the preprocessing

usePreProcessedAsInput

protected abstract boolean usePreProcessedAsInput()

Returns whether the preprocessed event is used as input token.

Returns:

true if used as input token

processEvent

protected String processEvent(E e)

Processes the event.

Returns:

null if execution successful, otherwise error message

size

public int size()

Returns the size of the group.

Specified by:

size in interface ActorHandler

Returns:

the number of actors

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

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

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

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

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

active

public int active()

Returns the number of non-skipped actors.

Returns:

the 'active' actors

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

check

public String check()

Performs checks on the "sub-actors".

Specified by:

check in interface ActorHandler

Returns:

null if everything OK, otherwise error message

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

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

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

always null

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

wrapUp

public void wrapUp()

Cleans up after the execution has finished. Graphical output is left untouched.

Specified by:

wrapUp in interface Actor

Overrides:

wrapUp in class AbstractActor

cleanUp

public void cleanUp()

Cleans up after the execution has finished. Also removes graphical components.

Specified by:

cleanUp in interface Actor

Specified by:

cleanUp in interface CleanUpHandler

Overrides:

cleanUp in class AbstractActor