Package adams.flow.core

Class AbstractCallableActorPropertyUpdater

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.core.AbstractPropertyUpdater

adams.flow.core.AbstractCallableActorPropertyUpdater

All Implemented Interfaces:

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

Direct Known Subclasses:

SetProperty, SetProperty

public abstract class AbstractCallableActorPropertyUpdater
extends AbstractPropertyUpdater

Abstract ancestor for actors that manipulate properties of callable actors, e.g., WEKA classes.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CallableActorReference	m_ActorName	the name of the global actor.
protected Actor	m_CallableActor	the callable actor to update the property for.
protected PropertyPath.PropertyContainer	m_Container	the property container of the property to update.

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

Method Summary

Modifier and Type	Method	Description
String	actorNameTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
CallableActorReference	getActorName()	Returns the name of the actor to update.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
void	setActorName(CallableActorReference value)	Sets the name of the actor to update.
String	setUp()	Initializes the item for flow execution.
protected void	updateProperty(String s)	Updates the property.

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, doExecute, 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, variableChanged, wrapUp

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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_ActorName

protected CallableActorReference m_ActorName

the name of the global actor.

m_CallableActor

protected transient Actor m_CallableActor

the callable actor to update the property for.

m_Container

protected transient PropertyPath.PropertyContainer m_Container

the property container of the property to update.

Constructor Detail

AbstractCallableActorPropertyUpdater

public AbstractCallableActorPropertyUpdater()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractPropertyUpdater

setActorName

public void setActorName(CallableActorReference value)

Sets the name of the actor to update.

Parameters:

value - the name

getActorName

public CallableActorReference getActorName()

Returns the name of the actor to update.

Returns:

the name

actorNameTipText

public String actorNameTipText()

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 AbstractPropertyUpdater

Returns:

null if no info available, otherwise short string

updateProperty

protected void updateProperty(String s)

Updates the property.

Specified by:

updateProperty in class AbstractPropertyUpdater

Parameters:

s - the string to set

setUp

public String setUp()

Initializes the item 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()