Package adams.flow.transformer

Class AbstractProcessWekaInstanceWithModel<T>

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

Type Parameters:

T - the type of model to use

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, ModelFileHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, DynamicInitializer, DynamicModelLoaderSupporter, ErrorHandler, InputConsumer, ModelLoaderSupporter, OptionalModelResetWithVariable, OutputProducer, Serializable, Comparable

Direct Known Subclasses:

WekaClassifying, WekaClustering

public abstract class AbstractProcessWekaInstanceWithModel<T>
extends AbstractTransformer
implements DynamicModelLoaderSupporter, OptionalModelResetWithVariable

Ancestor for transformers that user models for processing Instance objects, e.g., classifiers making predictions.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	BACKUP_MODEL	the key for storing the current model in the backup.
protected T	m_Model	the model that was loaded from the model file.
protected AbstractModelLoader	m_ModelLoader	the model loader.
protected VariableName	m_ModelResetVariable	the variable to monitor for changes, triggering resets of the model.
protected boolean	m_OnTheFly	whether the model gets built on the fly and might not be present at the start.
protected boolean	m_ResetModel	whether we need to reset the model.
protected boolean	m_UseModelResetVariable	whether to use a variable to monitor for changes, triggering resets of the model.

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

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.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
abstract Class[]	generates()	Returns the class of objects that it generates.
CallableActorReference	getModelActor()	Returns the filter source actor.
protected Class	getModelContainerClass()	Returns the model container class that is supported.
PlaceholderFile	getModelFile()	Returns the file to load the model from.
protected T	getModelFromContainer(AbstractContainer cont)	Retrieves the model from the container.
AbstractModelLoader.ModelLoadingType	getModelLoadingType()	Returns the loading type.
VariableName	getModelResetVariable()	Returns the variable to monitor for changes in order to reset the model.
StorageName	getModelStorage()	Returns the filter storage item.
boolean	getOnTheFly()	Returns whether the model file gets built on the fly and might not be present at start up time.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
boolean	getUseModelResetVariable()	Returns whether to use a variable to monitor for changes in order to reset the model.
protected void	initialize()	Initializes the members.
String	modelActorTipText()	Returns the tip text for this property.
String	modelFileTipText()	Returns the tip text for this property.
String	modelLoadingTypeTipText()	Returns the tip text for this property.
String	modelResetVariableTipText()	Returns the tip text for this property.
String	modelStorageTipText()	Returns the tip text for this property.
protected abstract AbstractModelLoader	newModelLoader()	Instantiates the model loader to use.
String	onTheFlyTipText()	Returns the tip text for this property.
protected abstract Token	processInstance(weka.core.Instance inst)	Processes the instance and generates the output token.
protected void	pruneBackup()	Removes entries from the backup.
protected void	reset()	Resets the scheme.
protected void	restoreState(Hashtable<String,Object> state)	Restores the state of the actor before the variables got updated.
void	setLoggingLevel(LoggingLevel value)	Sets the logging level.
void	setModelActor(CallableActorReference value)	Sets the filter source actor.
void	setModelFile(PlaceholderFile value)	Sets the file to load the model from.
void	setModelLoadingType(AbstractModelLoader.ModelLoadingType value)	Sets the loading type.
void	setModelResetVariable(VariableName value)	Sets the variable to monitor for changes in order to reset the model.
void	setModelStorage(StorageName value)	Sets the filter storage item.
void	setOnTheFly(boolean value)	Sets whether the model file gets built on the fly and might not be present at start up time.
String	setUp()	Initializes the item for flow execution.
protected String	setUpModel()	Loads the model from the model file.
void	setUseModelResetVariable(boolean value)	Sets whether to use a variable to monitor for changes in order to reset the model.
String	useModelResetVariableTipText()	Returns the tip text for this property.
void	variableChanged(VariableChangeEvent e)	Gets triggered when a variable changed (added, modified, removed).
void	wrapUp()	Cleans up after the execution has finished.

Methods inherited from class adams.flow.transformer.AbstractTransformer

currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, 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, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, 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, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

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_MODEL

public static final String BACKUP_MODEL

the key for storing the current model in the backup.

See Also:

Constant Field Values

m_Model

protected T m_Model

the model that was loaded from the model file.

m_OnTheFly

protected boolean m_OnTheFly

whether the model gets built on the fly and might not be present at the start.

m_UseModelResetVariable

protected boolean m_UseModelResetVariable

whether to use a variable to monitor for changes, triggering resets of the model.

m_ModelResetVariable

protected VariableName m_ModelResetVariable

the variable to monitor for changes, triggering resets of the model.

m_ResetModel

protected boolean m_ResetModel

whether we need to reset the model.

m_ModelLoader

protected AbstractModelLoader m_ModelLoader

the model loader.

Constructor Detail

AbstractProcessWekaInstanceWithModel

public AbstractProcessWekaInstanceWithModel()

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

initialize

protected void initialize()

Description copied from class: AbstractActor

Initializes the members.

Overrides:

initialize in class AbstractActor

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractActor

setLoggingLevel

public void setLoggingLevel(LoggingLevel value)

Sets the logging level.

Specified by:

setLoggingLevel in interface LoggingLevelHandler

Overrides:

setLoggingLevel in class AbstractOptionHandler

Parameters:

value - the level

newModelLoader

protected abstract AbstractModelLoader newModelLoader()

Instantiates the model loader to use.

Returns:

the model loader to use

setModelLoadingType

public void setModelLoadingType(AbstractModelLoader.ModelLoadingType value)

Sets the loading type. In case of AbstractModelLoader.ModelLoadingType.AUTO, first file, then callable actor, then storage.

Specified by:

setModelLoadingType in interface ModelLoaderSupporter

Parameters:

value - the type

getModelLoadingType

public AbstractModelLoader.ModelLoadingType getModelLoadingType()

Returns the loading type. In case of AbstractModelLoader.ModelLoadingType.AUTO, first file, then callable actor, then storage.

Specified by:

getModelLoadingType in interface ModelLoaderSupporter

Returns:

the type

modelLoadingTypeTipText

public String modelLoadingTypeTipText()

Returns the tip text for this property.

Specified by:

modelLoadingTypeTipText in interface ModelLoaderSupporter

Returns:

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

setModelFile

public void setModelFile(PlaceholderFile value)

Sets the file to load the model from.

Specified by:

setModelFile in interface ModelFileHandler

Specified by:

setModelFile in interface ModelLoaderSupporter

Parameters:

value - the model file

getModelFile

public PlaceholderFile getModelFile()

Returns the file to load the model from.

Specified by:

getModelFile in interface ModelFileHandler

Specified by:

getModelFile in interface ModelLoaderSupporter

Returns:

the model file

modelFileTipText

public String modelFileTipText()

Returns the tip text for this property.

Specified by:

modelFileTipText in interface ModelFileHandler

Specified by:

modelFileTipText in interface ModelLoaderSupporter

Returns:

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

setModelActor

public void setModelActor(CallableActorReference value)

Sets the filter source actor.

Specified by:

setModelActor in interface ModelLoaderSupporter

Parameters:

value - the source

getModelActor

public CallableActorReference getModelActor()

Returns the filter source actor.

Specified by:

getModelActor in interface ModelLoaderSupporter

Returns:

the source

modelActorTipText

public String modelActorTipText()

Returns the tip text for this property.

Specified by:

modelActorTipText in interface ModelLoaderSupporter

Returns:

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

setModelStorage

public void setModelStorage(StorageName value)

Sets the filter storage item.

Specified by:

setModelStorage in interface ModelLoaderSupporter

Parameters:

value - the storage item

getModelStorage

public StorageName getModelStorage()

Returns the filter storage item.

Specified by:

getModelStorage in interface ModelLoaderSupporter

Returns:

the storage item

modelStorageTipText

public String modelStorageTipText()

Returns the tip text for this property.

Specified by:

modelStorageTipText in interface ModelLoaderSupporter

Returns:

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

setOnTheFly

public void setOnTheFly(boolean value)

Sets whether the model file gets built on the fly and might not be present at start up time.

Specified by:

setOnTheFly in interface DynamicInitializer

Parameters:

value - if true then the model does not have to be present at start up time

getOnTheFly

public boolean getOnTheFly()

Returns whether the model file gets built on the fly and might not be present at start up time.

Specified by:

getOnTheFly in interface DynamicInitializer

Returns:

true if the model is not necessarily present at start up time

onTheFlyTipText

public String onTheFlyTipText()

Returns the tip text for this property.

Specified by:

onTheFlyTipText in interface DynamicInitializer

Returns:

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

setUseModelResetVariable

public void setUseModelResetVariable(boolean value)

Sets whether to use a variable to monitor for changes in order to reset the model.

Specified by:

setUseModelResetVariable in interface OptionalModelResetWithVariable

Parameters:

value - true if to use monitor variable

getUseModelResetVariable

public boolean getUseModelResetVariable()

Returns whether to use a variable to monitor for changes in order to reset the model.

Specified by:

getUseModelResetVariable in interface OptionalModelResetWithVariable

Returns:

true if to use monitor variable

useModelResetVariableTipText

public String useModelResetVariableTipText()

Returns the tip text for this property.

Specified by:

useModelResetVariableTipText in interface OptionalModelResetWithVariable

Returns:

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

setModelResetVariable

public void setModelResetVariable(VariableName value)

Sets the variable to monitor for changes in order to reset the model.

Specified by:

setModelResetVariable in interface OptionalModelResetWithVariable

Parameters:

value - the variable

getModelResetVariable

public VariableName getModelResetVariable()

Returns the variable to monitor for changes in order to reset the model.

Specified by:

getModelResetVariable in interface OptionalModelResetWithVariable

Returns:

the variable

modelResetVariableTipText

public String modelResetVariableTipText()

Returns the tip text for this property.

Specified by:

modelResetVariableTipText in interface OptionalModelResetWithVariable

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 AbstractActor

Returns:

null if no info available, otherwise short string

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Returns:

the accepted classes

generates

public abstract Class[] generates()

Returns the class of objects that it generates.

Specified by:

generates in interface OutputProducer

Returns:

the classes

pruneBackup

protected void pruneBackup()

Removes entries from the backup.

Overrides:

pruneBackup in class AbstractActor

See Also:

AbstractActor.reset()

backupState

protected Hashtable<String,Object> backupState()

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

Overrides:

backupState in class AbstractTransformer

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 AbstractTransformer

Parameters:

state - the backup of the state to restore from

See Also:

AbstractActor.updateVariables(), AbstractActor.backupState()

variableChanged

public void variableChanged(VariableChangeEvent e)

Gets triggered when a variable changed (added, modified, removed).

Specified by:

variableChanged in interface Actor

Specified by:

variableChanged in interface VariableChangeListener

Overrides:

variableChanged in class AbstractActor

Parameters:

e - the event

getModelContainerClass

protected Class getModelContainerClass()

Returns the model container class that is supported.

Returns:

the class

getModelFromContainer

protected T getModelFromContainer(AbstractContainer cont)

Retrieves the model from the container.

Parameters:

cont - the container to get the model from

Returns:

the model, null if not in container

setUpModel

protected String setUpModel()

Loads the model from the model file.

Returns:

null if everything worked, otherwise an error message

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

processInstance

protected abstract Token processInstance(weka.core.Instance inst)
                                  throws Exception

Processes the instance and generates the output token.

Parameters:

inst - the instance to process

Returns:

the generated output token (e.g., container)

Throws:

Exception - if processing fails

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

wrapUp

public void wrapUp()

Cleans up after the execution has finished.

Specified by:

wrapUp in interface Actor

Overrides:

wrapUp in class AbstractTransformer