Package adams.flow.standalone
Class SetProperty
-
- All Implemented Interfaces:
AdditionalInformationHandler,CleanUpHandler,Destroyable,GlobalInfoSupporter,LoggingLevelHandler,LoggingSupporter,OptionHandler,QuickInfoSupporter,ShallowCopySupporter<Actor>,SizeOfHandler,Stoppable,StoppableWithFeedback,VariablesInspectionHandler,VariableChangeListener,Actor,ErrorHandler,Serializable,Comparable
@Deprecated public class SetProperty extends AbstractCallableActorPropertyUpdater implements VariableChangeListener
Deprecated.Sets the property of a callable actor whenever the specified variable gets changed.
Note: this actor just sets the value, but performs no re-initialization or similar of the modified object.
-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: SetProperty
-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
-actor-name <adams.flow.core.CallableActorReference> (property: actorName) The name of the callable actor to update the property for. default: unknown
-property <java.lang.String> (property: property) The property to update whenever the variable changes. default:
-var-name <adams.core.VariableName> (property: variableName) The name of the variable to obtain the current value from. default: variable
- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected VariableNamem_VariableNameDeprecated.the name of the variable.-
Fields inherited from class adams.flow.core.AbstractCallableActorPropertyUpdater
m_ActorName, m_CallableActor, m_Container
-
Fields inherited from class adams.flow.core.AbstractPropertyUpdater
m_Property
-
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 SetProperty()Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voiddefineOptions()Deprecated.Adds options to the internal list of options.protected StringdoExecute()Deprecated.Does nothing, as it waits for changes in variables only.StringgetQuickInfo()Deprecated.Returns a quick info about the actor, which will be displayed in the GUI.VariableNamegetVariableName()Deprecated.Returns the name of the variable to obtain the current value from.StringglobalInfo()Deprecated.Returns a string describing the object.StringsetUp()Deprecated.Initializes the item for flow execution.voidsetVariableName(VariableName value)Deprecated.Sets the name of the variable to obtain the current value from.voidvariableChanged(VariableChangeEvent e)Deprecated.Gets triggered when a variable changed (added, modified, removed).StringvariableNameTipText()Deprecated.Returns the tip text for this property.-
Methods inherited from class adams.flow.core.AbstractCallableActorPropertyUpdater
actorNameTipText, getActorName, setActorName, updateProperty
-
Methods inherited from class adams.flow.core.AbstractPropertyUpdater
getProperty, propertyTipText, setProperty
-
Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, 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, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, 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
toCommandLine
-
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
-
-
-
-
Field Detail
-
m_VariableName
protected VariableName m_VariableName
Deprecated.the name of the variable.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Deprecated.Returns a string describing the object.- Specified by:
globalInfoin interfaceGlobalInfoSupporter- Specified by:
globalInfoin classAbstractOptionHandler- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Deprecated.Adds options to the internal list of options.- Specified by:
defineOptionsin interfaceOptionHandler- Overrides:
defineOptionsin classAbstractCallableActorPropertyUpdater
-
setVariableName
public void setVariableName(VariableName value)
Deprecated.Sets the name of the variable to obtain the current value from.- Parameters:
value- the name
-
getVariableName
public VariableName getVariableName()
Deprecated.Returns the name of the variable to obtain the current value from.- Returns:
- the name
-
variableNameTipText
public String variableNameTipText()
Deprecated.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()
Deprecated.Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfoin interfaceActor- Specified by:
getQuickInfoin interfaceQuickInfoSupporter- Overrides:
getQuickInfoin classAbstractCallableActorPropertyUpdater- Returns:
- null if no info available, otherwise short string
-
variableChanged
public void variableChanged(VariableChangeEvent e)
Deprecated.Gets triggered when a variable changed (added, modified, removed).- Specified by:
variableChangedin interfaceActor- Specified by:
variableChangedin interfaceVariableChangeListener- Overrides:
variableChangedin classAbstractActor- Parameters:
e- the event
-
setUp
public String setUp()
Deprecated.Initializes the item for flow execution.- Specified by:
setUpin interfaceActor- Overrides:
setUpin classAbstractCallableActorPropertyUpdater- Returns:
- null if everything is fine, otherwise error message
- See Also:
AbstractActor.reset()
-
doExecute
protected String doExecute()
Deprecated.Does nothing, as it waits for changes in variables only.- Specified by:
doExecutein classAbstractActor- Returns:
- always null
-
-