org.apache.samoa.moa.options

Class AbstractOptionHandler

java.lang.Object

org.apache.samoa.moa.AbstractMOAObject

org.apache.samoa.moa.options.AbstractOptionHandler

All Implemented Interfaces:

com.github.javacliparser.Configurable, Serializable, MOAObject, OptionHandler

Direct Known Subclasses:

AbstractChangeDetector, AbstractClassifier, AbstractClusterer, ArffFileStream, BinaryTreeNumericAttributeClassObserver, BinaryTreeNumericAttributeClassObserverRegression, ClusteringStream, FileStream, GaussianNumericAttributeClassObserver, GiniSplitCriterion, GreenwaldKhannaNumericAttributeClassObserver, HyperplaneGenerator, InfoGainSplitCriterion, NominalAttributeClassObserver, NullAttributeClassObserver, RandomTreeGenerator, VarianceReductionSplitCriterion, VFMLNumericAttributeClassObserver

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

Constructor Summary

Constructors

Constructor and Description
AbstractOptionHandler()

Method Summary

Modifier and Type	Method and Description
OptionHandler	copy() This method produces a copy of this object.
String	getCLICreationString(Class<?> expectedType) Gets the Command Line Interface text to create the object
com.github.javacliparser.Options	getOptions() Gets the options of this object
String	getPurposeString() Dictionary with option texts and objects
void	prepareForUse() This method prepares this object for use.
void	prepareForUse(TaskMonitor monitor, ObjectRepository repository) This method prepares this object for use.

Methods inherited from class org.apache.samoa.moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.samoa.moa.MOAObject

getDescription, measureByteSize

Constructor Detail

AbstractOptionHandler

public AbstractOptionHandler()

Method Detail

getPurposeString

public String getPurposeString()

Dictionary with option texts and objects

Specified by:

getPurposeString in interface OptionHandler

Returns:

the string with the purpose of this object

getOptions

public com.github.javacliparser.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

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