Package adams.flow.transformer

Class AbstractCallableWekaClassifierEvaluator

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

adams.flow.transformer.AbstractCallableWekaClassifierEvaluator

All Implemented Interfaces:

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

Direct Known Subclasses:

WekaCrossValidationEvaluator, WekaStreamEvaluator, WekaTrainTestSetEvaluator

public abstract class AbstractCallableWekaClassifierEvaluator
extends AbstractWekaClassifierEvaluator

Ancestor for classifier evaluators that make use of a callable classifier.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CallableActorReference	m_Classifier	the name of the callable weka classifier.
protected boolean	m_DiscardPredictions	whether to discard predictions.

Fields inherited from class adams.flow.transformer.AbstractWekaClassifierEvaluator

m_AlwaysUseContainer, m_Output, m_OutputBuffer

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

Method Summary

Modifier and Type	Method	Description
abstract String	classifierTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
String	discardPredictionsTipText()	Returns the tip text for this property.
CallableActorReference	getClassifier()	Returns the name of the callable classifier in use.
protected weka.classifiers.Classifier	getClassifierInstance()	Returns an instance of the callable classifier.
boolean	getDiscardPredictions()	Returns whether to discard the predictions in order to preserve memory.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
void	setClassifier(CallableActorReference value)	Sets the name of the callable classifier to use.
void	setDiscardPredictions(boolean value)	Sets whether to discard the predictions instead of collecting them for future use, in order to conserve memory.
String	setUp()	Initializes the item for flow execution.

Methods inherited from class adams.flow.transformer.AbstractWekaClassifierEvaluator

alwaysUseContainerTipText, cleanOutputBuffer, generates, getAlwaysUseContainer, getOutput, initOutputBuffer, outputTipText, reset, setAlwaysUseContainer, setOutput, wrapUp

Methods inherited from class adams.flow.transformer.AbstractTransformer

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

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, 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, 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.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.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_Classifier

protected CallableActorReference m_Classifier

the name of the callable weka classifier.

m_DiscardPredictions

protected boolean m_DiscardPredictions

whether to discard predictions.

Constructor Detail

AbstractCallableWekaClassifierEvaluator

public AbstractCallableWekaClassifierEvaluator()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractWekaClassifierEvaluator

setClassifier

public void setClassifier(CallableActorReference value)

Sets the name of the callable classifier to use.

Parameters:

value - the name

getClassifier

public CallableActorReference getClassifier()

Returns the name of the callable classifier in use.

Returns:

the name

classifierTipText

public abstract String classifierTipText()

Returns the tip text for this property.

Returns:

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

setDiscardPredictions

public void setDiscardPredictions(boolean value)

Sets whether to discard the predictions instead of collecting them for future use, in order to conserve memory.

Parameters:

value - true if to discard predictions

getDiscardPredictions

public boolean getDiscardPredictions()

Returns whether to discard the predictions in order to preserve memory.

Returns:

true if predictions discarded

discardPredictionsTipText

public String discardPredictionsTipText()

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 AbstractActor

Returns:

null if no info available, otherwise short string

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

getClassifierInstance

protected weka.classifiers.Classifier getClassifierInstance()

Returns an instance of the callable classifier.

Returns:

the classifier