de.lmu.ifi.dbs.elki.utilities.optionhandling
Interface Parameterizable

All Known Subinterfaces:

Algorithm<O>, Clustering<O>, Database<O>, DatabaseConnection<O>, DistanceFunction<O,D>, DistanceParser<O,D>, EigenPairFilter, Index<O>, KernelFunction<O,D>, MeasurementFunction<O,D>, Normalization<O>, Parser<O>, PCA, PreferenceVectorPreprocessor<O>, Preprocessor<O>, SimilarityFunction<O,D>, SpatialDistanceFunction<O,D>

All Known Implementing Classes:

AbstractAlgorithm, AbstractBiclustering, AbstractCorrelationDistanceFunction, AbstractDatabase, AbstractDatabaseConnection, AbstractDimensionsSelectingDoubleDistanceFunction, AbstractDistanceFunction, AbstractDoubleDistanceFunction, AbstractDoubleKernelFunction, AbstractFloatDistanceFunction, AbstractIntegerSimilarityFunction, AbstractKernelFunction, AbstractLocallyWeightedDistanceFunction, AbstractMeasurementFunction, AbstractMTree, AbstractNormalization, AbstractParameterizable, AbstractParser, AbstractPCA, AbstractPreprocessorBasedDistanceFunction, AbstractPreprocessorBasedSimilarityFunction, AbstractRStarTree, AbstractSimilarityFunction, APRIORI, ArbitraryKernelFunctionWrapper, AttributeWiseRealVectorNormalization, BitVectorLabelParser, CASH, CLIQUE, ClusterSimilarity, CompositeEigenPairFilter, COPAA, COPAC, CosineDistanceFunction, DBSCAN, DeLiClu, DeLiCluTree, DependencyDerivator, DimensionSelectingDistanceFunction, DimensionsSelectingEuklideanDistanceFunction, DirectSupportDependentItemsetDistanceFunction, DiSH, DiSHDistanceFunction, DiSHPreprocessor, DistanceBasedAlgorithm, DummyNormalization, EM, ERiC, ERiCDistanceFunction, EuklideanDistanceFunction, FileBasedDatabaseConnection, FileBasedDoubleDistanceFunction, FileBasedFloatDistanceFunction, FirstNEigenPairFilter, FooKernelFunction, FourC, FourCPreprocessor, FracClusPreprocessor, FractalDimensionBasedDistanceFunction, FrequencyDependentItemsetDistanceFunction, GlobalPCA, HiCOPreprocessor, HiSCDistanceFunction, HiSCPreprocessor, IndexDatabase, InputStreamDatabaseConnection, InvertedListDatabase, KDDTask, KernelBasedLocallyWeightedDistanceFunction, KernelFourCPreprocessor, KernelMatrix, KMeans, KNNDistanceOrder, KNNJoin, KnnQueryBasedHiCOPreprocessor, LimitEigenPairFilter, LinearKernelFunction, LinearLocalPCA, LocalKernelPCA, LocallyWeightedDistanceFunction, LocalPCA, LPNormDistanceFunction, ManhattanDistanceFunction, MetricalIndex, MetricalIndexDatabase, MkAppTree, MkCoPTree, MkMaxTree, MkTabTree, MTree, MultipleFileBasedDatabaseConnection, MultiRepresentedObjectNormalization, NonFlatRStarTree, NormalizingEigenPairFilter, NumberDistanceParser, OPTICS, ORCLUS, ParameterizationFunctionLabelParser, PCABasedCorrelationDistanceFunction, PercentageEigenPairFilter, PolynomialKernelFunction, PreDeCon, PreDeConPreprocessor, PreferenceVectorBasedCorrelationDistanceFunction, PROCLUS, ProjectedClustering, ProjectedDBSCAN, ProjectedDBSCANPreprocessor, RangeQueryBasedHiCOPreprocessor, RdKNNTree, RealVectorLabelParser, RealVectorLabelTransposingParser, ReciprocalSupportDependentItemsetDistanceFunction, RepresentationSelectingDistanceFunction, RStarTree, SequentialDatabase, SharedMaximumDistanceFunction, SharedNearestNeighborSimilarityFunction, SharedNearestNeighborsPreprocessor, SharedUnitedDistanceFunction, SharingDependentItemsetDistanceFunction, SLINK, SNNClustering, SparseBitVectorLabelParser, SpatialIndex, SpatialIndexDatabase, SquareRootSupportLengthDependentItemsetDistanceFunction, SubspaceDistanceFunction, SupportLengthDependentItemsetDistanceFunction, TreeIndex, WeightedDistanceFunction

public interface Parameterizable

Interface to define the required methods for command line interaction.

Author:

Arthur Zimek

Method Summary

void	checkGlobalParameterConstraints() Checks if all global parameter constraints are kept
String	description() Returns a description of the class and the required parameters.
List<AttributeSettings>	getAttributeSettings() Returns the setting of the attributes of the parameterizable.
String[]	getParameters() Returns the parameter array as given to the last call of setParameters(String[]) but without unnecessary entries.
Option<?>[]	getPossibleOptions() Returns an array containing all options of this parameterizable object
String	inlineDescription() Returns a description of the class and the required parameters.
String[]	setParameters(String[] args) Sets the attributes of the class accordingly to the given parameters.

Method Detail

description

String description()

Returns a description of the class and the required parameters.

This description should be suitable for a usage description as for a standalone application.

Returns:

String a description of the class and the required parameters

inlineDescription

String inlineDescription()

Returns a description of the class and the required parameters.

This description should be suitable for a usage description as for an inline application, i.e. the usage of a Parameterizable within another Parameterizable where this Parameterizable is not a parameter itself but is used and expects parameters.

Returns:

String a description of the class and the required parameters

setParameters

String[] setParameters(String[] args)
                       throws ParameterException

Sets the attributes of the class accordingly to the given parameters. Returns a new String array containing those entries of the given array that are neither expected nor used by this Parameterizable.

Parameters:

args - parameters to set the attributes accordingly to

Returns:

String[] an array containing the unused parameters

Throws:

ParameterException - in case of wrong parameter-setting

getParameters

String[] getParameters()

Returns the parameter array as given to the last call of setParameters(String[]) but without unnecessary entries. The provided array should be suitable to call setParameters(String[]) with it resulting in the identical parameterization.

Returns:

the parameter array as given to the last call of setParameters(String[]) but without unnecessary entries

getAttributeSettings

List<AttributeSettings> getAttributeSettings()

Returns the setting of the attributes of the parameterizable.

Returns:

the setting of the attributes of the parameterizable

getPossibleOptions

Option<?>[] getPossibleOptions()

Returns an array containing all options of this parameterizable object

Returns:

the options of this parameterizable object

checkGlobalParameterConstraints

void checkGlobalParameterConstraints()
                                     throws ParameterException

Checks if all global parameter constraints are kept

Throws:

ParameterException