Package adams.flow.control

Class StorageValueSequence

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

adams.flow.control.AbstractConnectedControlActor

adams.flow.control.MutableConnectedControlActor

adams.flow.control.Sequence

adams.flow.control.StorageValueSequence

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Pausable, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, FlowPauseStateListener, VariableChangeListener, AtomicExecution, Actor, ActorHandler, ControlActor, ErrorHandler, Flushable, InputConsumer, MutableActorHandler, OptionalStopRestrictor, OutputProducer, StopRestrictor, SubFlowWrapUp, Serializable, Comparable

public class StorageValueSequence
extends Sequence
implements OutputProducer

After executing a sequence of actors, the stored item is forwarded in the flow. This actor is useful if a storage item is modified in a series of Triggers or Tees, but still needs to be forwarded in the flow.

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


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

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

-actor <adams.flow.core.AbstractActor> [-actor ...] (property: actors)
    All the actors that define this sequence.
    default: 
 

-storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the stored value to forward in the flow.
    default: storage
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	BACKUP_HASOUTPUT	the key for storing the hasoutput status in the backup.
protected boolean	m_HasOutput	whether data is available.
protected StorageName	m_StorageName	the name of the stored value.

Fields inherited from class adams.flow.control.Sequence

BACKUP_CURRENT, m_AllowSource, m_AllowStandalones, m_CurrentToken, m_RestrictedStop, m_RestrictingStops

Fields inherited from class adams.flow.control.MutableConnectedControlActor

m_Actors

Fields inherited from class adams.flow.control.AbstractDirectedControlActor

m_Director, m_FinishBeforeStopping, m_StoppingTimeout, m_StoppingWarningInterval

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

Method Summary

Modifier and Type	Method	Description
protected Hashtable<String,Object>	backupState()	Backs up the current state of the actor before update the variables.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the actor.
Class[]	generates()	Returns the class of objects that it generates.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
StorageName	getStorageName()	Returns the name of the stored value.
String	globalInfo()	Returns a string describing the object.
boolean	hasPendingOutput()	Checks whether there is pending output to be collected after executing the flow item.
Token	output()	Returns the generated token.
protected void	pruneBackup()	Removes entries from the backup.
protected void	restoreState(Hashtable<String,Object> state)	Restores the state of the actor before the variables got updated.
void	setStorageName(StorageName value)	Sets the name of the stored value.
String	storageNameTipText()	Returns the tip text for this property.
void	wrapUp()	Finishes up the execution.

Methods inherited from class adams.flow.control.Sequence

accepts, actorsTipText, cleanUp, currentInput, getActorHandlerInfo, getAllowSource, getAllowStandalones, getDefaultRestrictingStops, hasInput, initialize, input, isRestrictedStop, isRestrictingStops, postExecute, preExecute, restrictedStopExecution, restrictedStopExecution, setAllowSource, setAllowStandalones, setRestrictingStops

Methods inherited from class adams.flow.control.MutableConnectedControlActor

add, add, get, getActors, indexOf, remove, removeAll, set, setActors, size

Methods inherited from class adams.flow.control.AbstractConnectedControlActor

check, checkConnections, classesToString

Methods inherited from class adams.flow.control.AbstractDirectedControlActor

finishBeforeStoppingTipText, flushExecution, getDirector, getFinishBeforeStopping, getStoppingTimeout, getStoppingWarningInterval, newDirector, setFinishBeforeStopping, setStoppingTimeout, setStoppingWarningInterval, setUp, stopExecution, stoppingTimeoutTipText, stoppingWarningIntervalTipText, updateVariables

Methods inherited from class adams.flow.control.AbstractControlActor

active, canInspectOptions, destroy, firstActive, firstInputConsumer, flowPauseStateChanged, forceVariables, isPaused, isSubFlowWrappedUp, lastActive, pauseExecution, reset, resumeExecution, setParent, setUpSubActors, updateParent, wrapUpSubFlow

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canPerformSetUpCheck, compareTo, configureLogger, 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, pruneBackup, setAnnotations, setErrorHandler, setName, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, variableChanged

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, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

Methods inherited from interface adams.flow.core.ActorHandler

check, firstActive, flushExecution, 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

BACKUP_HASOUTPUT

public static final String BACKUP_HASOUTPUT

the key for storing the hasoutput status in the backup.

See Also:

Constant Field Values

m_StorageName

protected StorageName m_StorageName

the name of the stored value.

m_HasOutput

protected boolean m_HasOutput

whether data is available.

Constructor Detail

StorageValueSequence

public StorageValueSequence()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Overrides:

globalInfo in class Sequence

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 MutableConnectedControlActor

setStorageName

public void setStorageName(StorageName value)

Sets the name of the stored value.

Parameters:

value - the name

getStorageName

public StorageName getStorageName()

Returns the name of the stored value.

Returns:

the name

storageNameTipText

public String storageNameTipText()

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 AbstractDirectedControlActor

Returns:

null if no info available, otherwise short string

pruneBackup

protected void pruneBackup()

Removes entries from the backup.

Overrides:

pruneBackup in class AbstractActor

See Also:

AbstractControlActor.reset()

backupState

protected Hashtable<String,Object> backupState()

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

Overrides:

backupState in class Sequence

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 Sequence

Parameters:

state - the backup of the state to restore from

See Also:

AbstractActor.updateVariables(), AbstractActor.backupState()

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

doExecute

protected String doExecute()

Executes the actor.

Overrides:

doExecute in class AbstractDirectedControlActor

Returns:

null if everything is fine, otherwise error message

hasPendingOutput

public boolean hasPendingOutput()

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

The method is not allowed allowed to return "true" before the actor has been executed. For actors that return an infinite number of tokens, the m_Executed flag can be returned.

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

wrapUp

public void wrapUp()

Finishes up the execution.

Specified by:

wrapUp in interface Actor

Overrides:

wrapUp in class Sequence