de.lmu.ifi.dbs.elki.utilities.optionhandling
Class AbstractParameterizer

java.lang.Object
  de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer

All Implemented Interfaces:

Parameterizer

Direct Known Subclasses:

AbstractAggarwalYuOutlier.Parameterizer, AbstractApplication.Parameterizer, AbstractDatabaseConnection.Parameterizer, AbstractDimensionsSelectingDoubleDistanceFunction.Parameterizer, AbstractDistanceBasedAlgorithm.Parameterizer, AbstractEditDistanceFunction.Parameterizer, AbstractFeatureSelectionFilter.Parameterizer, AbstractFilteredPCAIndex.Factory.Parameterizer, AbstractIndexBasedDistanceFunction.Parameterizer, AbstractIndexBasedSimilarityFunction.Parameterizer, AbstractMaterializeKNNPreprocessor.Factory.Parameterizer, AbstractNeighborhoodOutlier.Parameterizer, AbstractParser.Parameterizer, AbstractPrimitiveDistanceBasedAlgorithm.Parameterizer, AbstractProjectedClustering.Parameterizer, AbstractProjectedDBSCAN.Parameterizer, AbstractRandomFeatureSelectionFilter.Parameterizer, AbstractSimilarityAdapter.Parameterizer, AbstractSubspaceProjectionIndex.Factory.Parameterizer, AlgorithmStep.Parameterizer, ApproximateLeastOverlapInsertionStrategy.Parameterizer, APRIORI.Parameterizer, ArcCosineDistanceFunction.Parameterizer, ArffParser.Parameterizer, AttributeWiseMinMaxNormalization.Parameterizer, AttributeWiseVarianceNormalization.Parameterizer, AxisBasedReferencePoints.Parameterizer, BubbleVisualization.Factory.Parameterizer, ByLabelClustering.Parameterizer, ByLabelOutlier.Parameterizer, CASH.Parameterizer, ClassLabelFilter.Parameterizer, ClipScaling.Parameterizer, CLIQUE.Parameterizer, CompositeEigenPairFilter.Parameterizer, ComputeHSBColorHistogram.Parameterizer, ComputeNaiveHSBColorHistogram.Parameterizer, ComputeNaiveRGBColorHistogram.Parameterizer, ComputeOutlierHistogram.Parameterizer, ComputeROCCurve.Parameterizer, ComputeSimilarityMatrixImage.Parameterizer, COPAC.Parameterizer, CosineDistanceFunction.Parameterizer, DimensionSelectingDistanceFunction.Parameterizer, DimensionSelectingLatLngDistanceFunction.Parameterizer, DiSH.Parameterizer, DiSHPreferenceVectorIndex.Factory.Parameterizer, DiskCacheBasedDoubleDistanceFunction.Parameterizer, DiskCacheBasedFloatDistanceFunction.Parameterizer, EM.Parameterizer, EMOutlier.Parameterizer, ERiC.Parameterizer, EuclideanDistanceFunction.Parameterizer, EvaluatePairCountingFMeasure.Parameterizer, EvaluationStep.Parameterizer, ExtendedNeighborhood.Factory.Parameterizer, ExternalDoubleOutlierScore.Parameterizer, ExternalIDFilter.Parameterizer, ExternalNeighborhood.Factory.Parameterizer, FeatureBagging.Parameterizer, FileBasedDoubleDistanceFunction.Parameterizer, FileBasedFloatDistanceFunction.Parameterizer, FilterByLabelFilter.Parameterizer, FilterNoMissingValuesFilter.Parameterizer, FirstNEigenPairFilter.Parameterizer, FixedDBIDsFilter.Parameterizer, FooKernelFunction.Parameterizer, GammaScaling.Parameterizer, GaussianModel.Parameterizer, GaussianUniformMixture.Parameterizer, GeneratorXMLDatabaseConnection.Parameterizer, GridBasedReferencePoints.Parameterizer, HashmapDatabase.Parameterizer, HiCO.Parameterizer, HiSC.Parameterizer, HiSCPreferenceVectorIndex.Factory.Parameterizer, HistogramFactory.Parameterizer, HistogramIntersectionDistanceFunction.Parameterizer, HSBHistogramQuadraticDistanceFunction.Parameterizer, InputStep.Parameterizer, JSONResultHandler.Parameterizer, JudgeOutlierScores.Parameterizer, KDDTask.Parameterizer, KMLOutputHandler.Parameterizer, LatLngDistanceFunction.Parameterizer, LCSSDistanceFunction.Parameterizer, LimitEigenPairFilter.Parameterizer, LinearWeightedExtendedNeighborhood.Factory.Parameterizer, LngLatDistanceFunction.Parameterizer, LoggingStep.Parameterizer, LoOP.Parameterizer, LPNormDistanceFunction.Parameterizer, ManhattanDistanceFunction.Parameterizer, MaximumDistanceFunction.Parameterizer, MinimumDistanceFunction.Parameterizer, MinKDistance.Parameterizer, MinusLogGammaScaling.Parameterizer, OPTICSXi.Parameterizer, OutlierGammaScaling.Parameterizer, OutlierLinearScaling.Parameterizer, OutlierSqrtScaling.Parameterizer, OutputStep.Parameterizer, P1DHistogramVisualizer.Factory.Parameterizer, PCARunner.Parameterizer, PearsonCorrelationDistanceFunction.Parameterizer, PercentageEigenPairFilter.Parameterizer, PolynomialKernelFunction.Parameterizer, PrecomputedKNearestNeighborNeighborhood.Factory.Parameterizer, ProgressiveEigenPairFilter.Parameterizer, RandomGeneratedReferencePoints.Parameterizer, RandomSampleReferencePoints.Parameterizer, RandomStableDistanceFunction.Parameterizer, RelativeEigenPairFilter.Parameterizer, RescaleMetaOutlierAlgorithm.Parameterizer, ResultVisualizer.Parameterizer, ResultWriter.Parameterizer, RGBHistogramQuadraticDistanceFunction.Parameterizer, ScatterPlotFactory.Parameterizer, SelectionCubeVisualization.Factory.Parameterizer, SharedNearestNeighborPreprocessor.Factory.Parameterizer, ShuffleObjectsFilter.Parameterizer, SignificantEigenPairFilter.Parameterizer, SNNClustering.Parameterizer, SOD.Parameterizer, SplitNumberVectorFilter.Parameterizer, SqrtStandardDeviationScaling.Parameterizer, SquaredEuclideanDistanceFunction.Parameterizer, SquaredPearsonCorrelationDistanceFunction.Parameterizer, StandardDeviationScaling.Parameterizer, StarBasedReferencePoints.Parameterizer, StaticArrayDatabase.Parameterizer, SUBCLU.Parameterizer, TooltipScoreVisualization.Factory.Parameterizer, TopKOutlierScaling.Parameterizer, TreeIndexFactory.Parameterizer, TreeMBRVisualization.Factory.Parameterizer, TreeSphereVisualization.Factory.Parameterizer, UnweightedNeighborhoodAdapter.Factory.Parameterizer, VisualizerParameterizer.Parameterizer, WeakEigenPairFilter.Parameterizer, WeightedCovarianceMatrixBuilder.Parameterizer

public abstract class AbstractParameterizer
extends Object
implements Parameterizer

Abstract base class that handles the parameterization of a class.

Field Summary

private int	state Parameterization state.
private static int	STATE_COMPLETE Constant for "complete" state
private static int	STATE_ERRORS Constant for "errors" state
private static int	STATE_FRESH Constant for "fresh" state
private static int	STATE_INIT Constant for "initializing" state

Constructor Summary

AbstractParameterizer()

Method Summary

void	configure(Parameterization config) Configure the class.
Object	make(Parameterization config) Method to configure a class, then instantiate when the configuration step was successful.
protected abstract Object	makeInstance() Make an instance after successful configuration.
protected void	makeOptions(Parameterization config) Add all options.

Methods inherited from class java.lang.Object

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

Field Detail

STATE_FRESH

private static final int STATE_FRESH

Constant for "fresh" state

See Also:

Constant Field Values

STATE_INIT

private static final int STATE_INIT

Constant for "initializing" state

See Also:

Constant Field Values

STATE_COMPLETE

private static final int STATE_COMPLETE

Constant for "complete" state

See Also:

Constant Field Values

STATE_ERRORS

private static final int STATE_ERRORS

Constant for "errors" state

See Also:

Constant Field Values

state

private int state

Parameterization state.

Constructor Detail

AbstractParameterizer

public AbstractParameterizer()

Method Detail

makeOptions

protected void makeOptions(Parameterization config)

Add all options. ALWAYS call super.makeOptions(config), unless you have a strong reason to do otherwise!

Parameters:

config - Parameterization to add options to.

configure

public final void configure(Parameterization config)

Description copied from interface: Parameterizer

Configure the class. Note: the status is collected by the parameterization object, so that multiple errors may arise and be reported in one run.

Specified by:

configure in interface Parameterizer

Parameters:

config - Parameterization

makeInstance

protected abstract Object makeInstance()

Make an instance after successful configuration.

Returns:

instance

make

public final Object make(Parameterization config)

Method to configure a class, then instantiate when the configuration step was successful. Don't call this directly use unless you know what you are doing.
Instead, use Parameterization.tryInstantiate(Class)! Otherwise, null will be returned, and the resulting errors can be retrieved from the Parameterization parameter object. In general, you should be checking the Parameterization object for errors before accessing the returned value, since it may be null unexpectedly otherwise.

Parameters:

config - Parameterization

Returns:

Instance or null