Package adams.flow.standalone

Class VariableChangedEvent

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<VariableChangeEvent,Object>

adams.flow.standalone.VariableChangedEvent

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

public class VariableChangedEvent
extends AbstractMutableActorDaemonEvent<VariableChangeEvent,Object>

Listens to a any changes to the specified variable.
This allows, for instance, the monitoring of a variable.
Enable the 'noDiscard' property to process all change events - NB: this can slow down the system significantly.

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

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

-variable <adams.core.VariableNameNoUpdate> (property: variable)
    The variable to monitor for changes.
    default: variable
 

-no-discard <boolean> (property: noDiscard)
    If enabled, no change event gets discarded; CAUTION: enabling this option 
    can slow down the system significantly.
    default: false
 

-actor <adams.flow.core.Actor> [-actor ...] (property: actors)
    The actors to execute in case of a change event.
    default: 
 

For more information on the schedule format, see CronTrigger Tutorial.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected VariableNameNoUpdate	m_Variable	the variable to listen to.

Fields inherited from class adams.flow.standalone.AbstractMutableActorDaemonEvent

BUSY, m_Actors, m_ExecutingActors, m_NoDiscard, NO_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
VariableChangedEvent()

Method Summary

Modifier and Type	Method	Description
protected String	checkActors(Actor[] actors)	Checks the actors before they are set via the setActors method.
void	defineOptions()	Adds options to the internal list of options.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
VariableNameNoUpdate	getVariable()	Returns the variable to monitor
String	globalInfo()	Returns a string describing the object.
protected boolean	handlesEvent(VariableChangeEvent e)	Checks whether the event is being handled.
protected Object	preProcessEvent(VariableChangeEvent e)	Preprocesses the event.
void	setVariable(VariableNameNoUpdate value)	Sets the variable to monitor.
protected boolean	usePreProcessedAsInput()	Returns whether the preprocessed event is used as input token.
void	variableChanged(VariableChangeEvent e)	Gets triggered when a variable changed (added, modified, removed).
String	variableTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.standalone.AbstractMutableActorDaemonEvent

active, actorsTipText, add, add, check, cleanUp, doExecute, firstActive, flushExecution, forceVariables, get, getActorHandlerInfo, getActors, getNoDiscard, indexOf, initialize, lastActive, noDiscardTipText, processEvent, remove, removeAll, set, setActors, setLoggingLevel, setNoDiscard, setUp, size, stopExecution, updateParent, wrapUp

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

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

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

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

m_Variable

protected VariableNameNoUpdate m_Variable

the variable to listen to.

Constructor Detail

VariableChangedEvent

public VariableChangedEvent()

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 AbstractMutableActorDaemonEvent<VariableChangeEvent,Object>

setVariable

public void setVariable(VariableNameNoUpdate value)

Sets the variable to monitor.

Parameters:

value - the variable

getVariable

public VariableNameNoUpdate getVariable()

Returns the variable to monitor

Returns:

the variable

variableTipText

public String variableTipText()

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

checkActors

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

Specified by:

checkActors in class AbstractMutableActorDaemonEvent<VariableChangeEvent,Object>

Parameters:

actors - the actors to check

Returns:

null if accepted, otherwise error message

handlesEvent

protected boolean handlesEvent(VariableChangeEvent e)

Checks whether the event is being handled.

Specified by:

handlesEvent in class AbstractMutableActorDaemonEvent<VariableChangeEvent,Object>

Parameters:

e - the event to check

Returns:

true if being handled

preProcessEvent

protected Object preProcessEvent(VariableChangeEvent e)

Preprocesses the event.

Specified by:

preProcessEvent in class AbstractMutableActorDaemonEvent<VariableChangeEvent,Object>

Parameters:

e - the event to preprocess

Returns:

the output of the preprocessing

usePreProcessedAsInput

protected boolean usePreProcessedAsInput()

Returns whether the preprocessed event is used as input token.

Specified by:

usePreProcessedAsInput in class AbstractMutableActorDaemonEvent<VariableChangeEvent,Object>

Returns:

always false

variableChanged

public void variableChanged(VariableChangeEvent e)

Gets triggered when a variable changed (added, modified, removed).

Specified by:

variableChanged in interface Actor

Specified by:

variableChanged in interface VariableChangeListener

Overrides:

variableChanged in class AbstractActor

Parameters:

e - the event