Package adams.flow.control

Class UpdateProperties

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

All Implemented Interfaces:

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

public class UpdateProperties
extends AbstractControlActor
implements InputConsumer, OutputProducer, PropertiesUpdater

Updates the properties of the sub-actor using the values associated with the specfiied variables. The input/output of the actor are the same as the ones of the sub-actor, since this control actor merely functions as wrapper.

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

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

-property <adams.core.base.BaseString> [-property ...] (property: properties)
    The properties to update with the values associated with the specified values.
    default:
 

-variable <adams.core.VariableName> [-variable ...] (property: variableNames)
    The names of the variables to update the properties with.
    default:
 

-sub-actor <adams.flow.core.Actor> (property: subActor)
    The transformer to update the properties for.
    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 input token in the backup.
static String	BACKUP_OUTPUT	the key for storing the output token in the backup.
protected PropertyPath.PropertyContainer[]	m_Containers	the property containers of the properties to update.
protected Token	m_InputToken	the current input token.
protected Token	m_OutputToken	the current output token.
protected BaseString[]	m_Properties	the property paths.
protected Actor	m_SubActor	the actor to update the properties foe.
protected VariableName[]	m_VariableNames	the variables to update the properties with.

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

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
protected Hashtable<String,Object>	backupState()	Backs up the current state of the actor before update the variables.
protected String	checkSubActor(Actor actor)	Checks the sub-actor before it is set via the setSubActor method.
Token	currentInput()	Returns the current input token, if any.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
String	execute()	Executes the flow item.
void	flushExecution()	Stops the processing of tokens without stopping the flow.
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.
BaseString[]	getProperties()	Returns the properties to update.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
Actor	getSubActor()	Returns the sub-actor.
VariableName[]	getVariableNames()	Returns the variables 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.
int	indexOf(String actor)	Returns the index of the actor.
void	input(Token token)	The method that accepts the input token and then processes it.
Token	output()	Returns the generated token.
String	propertiesTipText()	Returns the tip text for this property.
protected void	reset()	Resets the scheme.
protected void	restoreState(Hashtable<String,Object> state)	Restores the state of the actor before the variables got updated.
String	set(int index, Actor actor)	Sets the actor at the given position.
void	setProperties(BaseString[] value)	Sets the properties to update.
void	setSubActor(Actor value)	Sets the sub actor.
String	setUp()	Initializes the item for flow execution.
void	setVariableNames(VariableName[] value)	Sets the variables to use.
int	size()	Returns the size of the group.
String	subActorTipText()	Returns the tip text for this property.
String	variableNamesTipText()	Returns the tip text for this property.
void	wrapUp()	Cleans up after the execution has finished.

Methods inherited from class adams.flow.control.AbstractControlActor

active, canInspectOptions, check, cleanUp, destroy, firstActive, firstInputConsumer, flowPauseStateChanged, forceVariables, initialize, isPaused, isSubFlowWrappedUp, lastActive, pauseExecution, preExecute, resumeExecution, setParent, setUpSubActors, stopExecution, updateParent, wrapUpSubFlow

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canPerformSetUpCheck, compareTo, configureLogger, equals, 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, setAnnotations, setErrorHandler, setName, 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, 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, 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, stopExecution, toCommandLine, variableChanged

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_INPUT

public static final String BACKUP_INPUT

the key for storing the input token in the backup.

See Also:

Constant Field Values

BACKUP_OUTPUT

public static final String BACKUP_OUTPUT

the key for storing the output token in the backup.

See Also:

Constant Field Values

m_InputToken

protected transient Token m_InputToken

the current input token.

m_OutputToken

protected transient Token m_OutputToken

the current output token.

m_Properties

protected BaseString[] m_Properties

the property paths.

m_VariableNames

protected VariableName[] m_VariableNames

the variables to update the properties with.

m_SubActor

protected Actor m_SubActor

the actor to update the properties foe.

m_Containers

protected transient PropertyPath.PropertyContainer[] m_Containers

the property containers of the properties to update.

Constructor Detail

UpdateProperties

public UpdateProperties()

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

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractControlActor

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

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

setProperties

public void setProperties(BaseString[] value)

Sets the properties to update.

Specified by:

setProperties in interface PropertiesUpdater

Parameters:

value - the properties

getProperties

public BaseString[] getProperties()

Returns the properties to update.

Specified by:

getProperties in interface PropertiesUpdater

Returns:

the properties

propertiesTipText

public String propertiesTipText()

Returns the tip text for this property.

Specified by:

propertiesTipText in interface PropertiesUpdater

Returns:

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

setVariableNames

public void setVariableNames(VariableName[] value)

Sets the variables to use.

Specified by:

setVariableNames in interface PropertiesUpdater

Parameters:

value - the variables

getVariableNames

public VariableName[] getVariableNames()

Returns the variables to use.

Specified by:

getVariableNames in interface PropertiesUpdater

Returns:

the variables

variableNamesTipText

public String variableNamesTipText()

Returns the tip text for this property.

Specified by:

variableNamesTipText in interface PropertiesUpdater

Returns:

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

checkSubActor

protected String checkSubActor(Actor actor)

Checks the sub-actor before it is set via the setSubActor method. Returns an error message if the actor is not acceptable, null otherwise.

Parameters:

actor - the actor to check

Returns:

null if accepted, otherwise error message

setSubActor

public void setSubActor(Actor value)

Sets the sub actor.

Parameters:

value - the actor

getSubActor

public Actor getSubActor()

Returns the sub-actor.

Returns:

the actor

subActorTipText

public String subActorTipText()

Returns the tip text for this property.

Returns:

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

size

public int size()

Returns the size of the group.

Specified by:

size in interface ActorHandler

Specified by:

size in class AbstractControlActor

Returns:

always 1

get

public Actor get(int index)

Returns the actor at the given position.

Specified by:

get in interface ActorHandler

Specified by:

get in class AbstractControlActor

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

Specified by:

set in class AbstractControlActor

Parameters:

index - the position

actor - the actor to set at this position

Returns:

null if everything is fine, otherwise the error

indexOf

public int indexOf(String actor)

Returns the index of the actor.

Specified by:

indexOf in interface ActorHandler

Specified by:

indexOf in class AbstractControlActor

Parameters:

actor - the name of the actor to look for

Returns:

the index of -1 if not found

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

Specified by:

getActorHandlerInfo in class AbstractControlActor

Returns:

the info

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Returns:

adams.flow.core.Unknown.class

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

See Also:

m_InputToken

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:

adams.flow.core.Unknown.class

setUp

public String setUp()

Initializes the item for flow execution.

Specified by:

setUp in interface Actor

Overrides:

setUp in class AbstractControlActor

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:

null if everything is fine, otherwise error message

execute

public String execute()

Executes the flow item.

Specified by:

execute in interface Actor

Overrides:

execute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

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

Overrides:

flushExecution in class AbstractControlActor

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

wrapUp

public void wrapUp()

Cleans up after the execution has finished.

Specified by:

wrapUp in interface Actor

Overrides:

wrapUp in class AbstractControlActor