adams.flow.transformer
Class AbstractGlobalWekaClassifierEvaluator

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.AbstractWekaClassifierEvaluator
                      adams.flow.transformer.AbstractGlobalWekaClassifierEvaluator

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

Direct Known Subclasses:

WekaCrossValidationEvaluator, WekaTrainTestSetEvaluator

public abstract class AbstractGlobalWekaClassifierEvaluator
extends AbstractWekaClassifierEvaluator

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

Version:

$Revision: 5766 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected GlobalActorReference	m_Classifier the name of the global weka classifier.
protected boolean	m_DiscardPredictions whether to discard predictions.

Fields inherited from class adams.flow.transformer.AbstractWekaClassifierEvaluator

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

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

AbstractGlobalWekaClassifierEvaluator()

Method Summary

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.
GlobalActorReference	getClassifier() Returns the name of the global classifier in use.
protected weka.classifiers.Classifier	getClassifierInstance() Returns an instance of the global 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(GlobalActorReference value) Sets the name of the global 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

generates, getOutput, outputTipText, reset, setOutput, wrapUp

Methods inherited from class adams.flow.transformer.AbstractTransformer

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

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, doExecute, equals, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, globalInfo, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.InputConsumer

accepts

Field Detail

m_Classifier

protected GlobalActorReference m_Classifier

the name of the global weka classifier.

m_DiscardPredictions

protected boolean m_DiscardPredictions

whether to discard predictions.

Constructor Detail

AbstractGlobalWekaClassifierEvaluator

public AbstractGlobalWekaClassifierEvaluator()

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

Sets the name of the global classifier to use.

Parameters:

value - the name

getClassifier

public GlobalActorReference getClassifier()

Returns the name of the global 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 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.

Overrides:

setUp in class AbstractActor

Returns:

null if everything is fine, otherwise error message

getClassifierInstance

protected weka.classifiers.Classifier getClassifierInstance()

Returns an instance of the global classifier.

Returns:

the classifier