moa.options

Class AbstractOptionHandler

java.lang.Object

moa.AbstractMOAObject

moa.options.AbstractOptionHandler

All Implemented Interfaces:

Serializable, MOAObject, OptionHandler

Direct Known Subclasses:

AbstractChangeDetector, AbstractClassifier, AbstractClusterer, AbstractConceptDriftGenerator, AbstractStreamFilter, AbstractTask, AgrawalGenerator, ArffFileStream, BaselinePredictor, BinaryTreeNumericAttributeClassObserver, BinaryTreeNumericAttributeClassObserverRegression, BRISMFPredictor, ClusteringStream, ConceptDriftRealStream, ConceptDriftStream, EWMAClassificationPerformanceEvaluator, FadingFactorClassificationPerformanceEvaluator, FilteredStream, FlixsterDataset, GaussianNumericAttributeClassObserver, GiniSplitCriterion, GreenwaldKhannaNumericAttributeClassObserver, HyperplaneGenerator, InfoGainSplitCriterion, JesterDataset, LEDGenerator, MemRecommenderData, MetaMultilabelGenerator, MovielensDataset, MultiFilteredStream, NominalAttributeClassObserver, NullAttributeClassObserver, RandomRBFGenerator, RandomTreeGenerator, SEAGenerator, STAGGERGenerator, VarianceReductionSplitCriterion, VFMLNumericAttributeClassObserver, WaveformGenerator, WindowClassificationPerformanceEvaluator, WindowRegressionPerformanceEvaluator

public abstract class AbstractOptionHandler
extends AbstractMOAObject
implements OptionHandler

Abstract Option Handler. All classes that have options in MOA extend this class.

Version:

$Revision: 7 $

Author:

Richard Kirkby (rkirkby@cs.waikato.ac.nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	classOptionNamesToPreparedObjects Dictionary with option texts and objects
protected Options	options Options to handle

Constructor Summary

Constructors

Constructor and Description
AbstractOptionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
OptionHandler	copy() This method produces a copy of this object.
protected Option[]	discoverOptionsViaReflection() Gets the options of this class via reflection.
String	getCLICreationString(Class<?> expectedType) Gets the Command Line Interface text to create the object
Options	getOptions() Gets the options of this object
protected Object	getPreparedClassOption(ClassOption opt) Gets a prepared option of this class.
protected Object	getPreparedClassOption(ClassOptionWithNames opt) Gets a prepared option of this class.
String	getPurposeString() Gets the purpose of this object
protected void	prepareClassOptions(TaskMonitor monitor, ObjectRepository repository) Prepares the options of this class.
void	prepareForUse() This method prepares this object for use.
void	prepareForUse(TaskMonitor monitor, ObjectRepository repository) This method prepares this object for use.
protected abstract void	prepareForUseImpl(TaskMonitor monitor, ObjectRepository repository) This method describes the implementation of how to prepare this object for use.

Methods inherited from class moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface moa.MOAObject

getDescription, measureByteSize

Field Detail

options

protected Options options

Options to handle

classOptionNamesToPreparedObjects

protected Map<String,Object> classOptionNamesToPreparedObjects

Dictionary with option texts and objects

Constructor Detail

AbstractOptionHandler

public AbstractOptionHandler()

Method Detail

getPurposeString

public String getPurposeString()

Description copied from interface: OptionHandler

Gets the purpose of this object

Specified by:

getPurposeString in interface OptionHandler

Returns:

the string with the purpose of this object

getOptions

public Options getOptions()

Description copied from interface: OptionHandler

Gets the options of this object

Specified by:

getOptions in interface OptionHandler

Returns:

the options of this object

prepareForUse

public void prepareForUse()

Description copied from interface: OptionHandler

This method prepares this object for use.

Specified by:

prepareForUse in interface OptionHandler

prepareForUse

public void prepareForUse(TaskMonitor monitor,
                 ObjectRepository repository)

Description copied from interface: OptionHandler

This method prepares this object for use.

Specified by:

prepareForUse in interface OptionHandler

Parameters:

monitor - the TaskMonitor to use

repository - the ObjectRepository to use

prepareForUseImpl

protected abstract void prepareForUseImpl(TaskMonitor monitor,
                     ObjectRepository repository)

This method describes the implementation of how to prepare this object for use. All classes that extends this class have to implement prepareForUseImpl and not prepareForUse since prepareForUse calls prepareForUseImpl.

Parameters:

monitor - the TaskMonitor to use

repository - the ObjectRepository to use

getCLICreationString

public String getCLICreationString(Class<?> expectedType)

Description copied from interface: OptionHandler

Gets the Command Line Interface text to create the object

Specified by:

getCLICreationString in interface OptionHandler

Returns:

the Command Line Interface text to create the object

copy

public OptionHandler copy()

Description copied from interface: MOAObject

This method produces a copy of this object.

Specified by:

copy in interface MOAObject

Specified by:

copy in interface OptionHandler

Overrides:

copy in class AbstractMOAObject

Returns:

a copy of this object

discoverOptionsViaReflection

protected Option[] discoverOptionsViaReflection()

Gets the options of this class via reflection.

Returns:

an array of options

prepareClassOptions

protected void prepareClassOptions(TaskMonitor monitor,
                       ObjectRepository repository)

Prepares the options of this class.

Parameters:

monitor - the TaskMonitor to use

repository - the ObjectRepository to use

getPreparedClassOption

protected Object getPreparedClassOption(ClassOption opt)

Gets a prepared option of this class.

Parameters:

opt - the class option to get

Returns:

an option stored in the dictionary

getPreparedClassOption

protected Object getPreparedClassOption(ClassOptionWithNames opt)

Gets a prepared option of this class.

Parameters:

opt - - ClassOptionWithNames

Returns:

an option stored in the dictionary