Package adams.flow.transformer

Class AbstractTransformerWithPropertiesUpdating

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.transformer.AbstractTransformer

adams.flow.transformer.AbstractTransformerWithPropertiesUpdating

All Implemented Interfaces:

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

Direct Known Subclasses:

WekaFilter, WekaStreamFilter

public abstract class AbstractTransformerWithPropertiesUpdating
extends AbstractTransformer
implements PropertiesUpdater

Ancestor for transformers that allow changing the object's properties using variables.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PropertyPath.PropertyContainer[]	m_Containers	the property containers of the properties to update.
protected BaseString[]	m_Properties	the property paths.
protected VariableName[]	m_VariableNames	the variables to update the properties with.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
BaseString[]	getProperties()	Returns the properties to update.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
VariableName[]	getVariableNames()	Returns the variables to use.
String	propertiesTipText()	Returns the tip text for this property.
protected void	reset()	Resets the scheme.
void	setProperties(BaseString[] value)	Sets the properties to update.
String	setUpContainers(Object obj)	Initializes the property containers.
String	setUpContainersIfNecessary(Object obj)	Initializes the property containers.
void	setVariableNames(VariableName[] value)	Sets the variables to use.
protected String	updateObject(Object obj)	Updates the object with the current variable values.
String	variableNamesTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, doExecute, equals, 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, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

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

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

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.flow.core.InputConsumer

accepts

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.flow.core.OutputProducer

generates

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_Properties

protected BaseString[] m_Properties

the property paths.

m_VariableNames

protected VariableName[] m_VariableNames

the variables to update the properties with.

m_Containers

protected transient PropertyPath.PropertyContainer[] m_Containers

the property containers of the properties to update.

Constructor Detail

AbstractTransformerWithPropertiesUpdating

public AbstractTransformerWithPropertiesUpdating()

Method Detail

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 AbstractActor

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

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.

setUpContainersIfNecessary

public String setUpContainersIfNecessary(Object obj)

Initializes the property containers.

Returns:

null if everything is fine, otherwise error message

setUpContainers

public String setUpContainers(Object obj)

Initializes the property containers.

Returns:

null if everything is fine, otherwise error message

updateObject

protected String updateObject(Object obj)

Updates the object with the current variable values.

Returns:

null if everything is fine, otherwise error message