org.apache.samoa.moa.options

Interface OptionHandler

All Superinterfaces:

com.github.javacliparser.Configurable, MOAObject, Serializable

All Known Subinterfaces:

AttributeClassObserver, ChangeDetector, Classifier, Clusterer, DiscreteAttributeClassObserver, Learner<E>, NumericAttributeClassObserver, SplitCriterion

All Known Implementing Classes:

AbstractChangeDetector, AbstractClassifier, AbstractClusterer, AbstractOptionHandler, ADWINChangeDetector, ArffFileStream, ArffFileStream, BinaryTreeNumericAttributeClassObserver, BinaryTreeNumericAttributeClassObserverRegression, ClusterGenerator, ClusteringStream, Clustream, CusumDM, DDM, EDDM, EWMAChartDM, FileStream, FIMTDDNumericAttributeClassLimitObserver, FIMTDDNumericAttributeClassObserver, GaussianNumericAttributeClassObserver, GeometricMovingAverageDM, GiniSplitCriterion, GreenwaldKhannaNumericAttributeClassObserver, HyperplaneGenerator, InfoGainSplitCriterion, InfoGainSplitCriterionMultilabel, MajorityClass, NominalAttributeClassObserver, NullAttributeClassObserver, PageHinkleyDM, Perceptron, RandomRBFGeneratorEvents, RandomTreeGenerator, SDRSplitCriterion, SDRSplitCriterionAMRules, TargetMean, VarianceReductionSplitCriterion, VFMLNumericAttributeClassObserver, WithKmeans

public interface OptionHandler
extends MOAObject, com.github.javacliparser.Configurable

Interface representing an object that handles options or parameters.

Version:

$Revision: 7 $

Author:

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

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() Gets the purpose of this object
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 interface org.apache.samoa.moa.MOAObject

getDescription, measureByteSize

Method Detail

getPurposeString

String getPurposeString()

Gets the purpose of this object

Returns:

the string with the purpose of this object

getOptions

com.github.javacliparser.Options getOptions()

Gets the options of this object

Returns:

the options of this object

prepareForUse

void prepareForUse()

This method prepares this object for use.

prepareForUse

void prepareForUse(TaskMonitor monitor,
                   ObjectRepository repository)

This method prepares this object for use.

Parameters:

monitor - the TaskMonitor to use

repository - the ObjectRepository to use

copy

OptionHandler copy()

This method produces a copy of this object.

Specified by:

copy in interface MOAObject

Returns:

a copy of this object

getCLICreationString

String getCLICreationString(Class<?> expectedType)

Gets the Command Line Interface text to create the object

Returns:

the Command Line Interface text to create the object