de.lmu.ifi.dbs.elki.application

Class AbstractApplication.Parameterizer

java.lang.Object

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

de.lmu.ifi.dbs.elki.application.AbstractApplication.Parameterizer

All Implemented Interfaces:

Parameterizer

Direct Known Subclasses:

CacheDoubleDistanceInOnDiskMatrix.Parameterizer, CacheDoubleDistanceKNNLists.Parameterizer, CacheDoubleDistanceRangeQueries.Parameterizer, CacheFloatDistanceInOnDiskMatrix.Parameterizer, ClassifierHoldoutEvaluationTask.Parameterizer, ComputeKNNOutlierScores.Parameterizer, ConvertToBundleApplication.Parameterizer, EvaluateIntrinsicDimensionalityEstimators.Parameterizer, EvaluatePrecomputedOutlierScores.Parameterizer, GeneratorXMLSpec.Parameterizer, GreedyEnsembleExperiment.Parameterizer, KDDCLIApplication.Parameterizer, PrecomputeDistancesAsciiApplication.Parameterizer, VisualizeGeodesicDistances.Parameterizer, VisualizePairwiseGainMatrix.Parameterizer

Enclosing class:

AbstractApplication

public abstract static class AbstractApplication.Parameterizer
extends AbstractParameterizer

Parameterization class.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
static OptionID	DATABASE_ID Option ID to specify the database type
static OptionID	DEBUG_ID Optional Parameter to specify a class to enable debugging for.
static OptionID	DESCRIPTION_ID Optional Parameter to specify a class to obtain a description for.
static OptionID	HELP_ID Flag to obtain help-message.
static OptionID	HELP_LONG_ID Flag to obtain help-message.
static OptionID	INPUT_ID Parameter that specifies the name of the input file.
static OptionID	OUTPUT_ID Parameter that specifies the name of the output file.
static OptionID	VERBOSE_ID Flag to allow verbose messages while running the application.

Constructor Summary

Constructors

Constructor and Description
Parameterizer()

Method Summary

Modifier and Type	Method and Description
protected java.io.File	getParameterInputFile(Parameterization config) Get the input file parameter.
protected java.io.File	getParameterInputFile(Parameterization config, java.lang.String description) Get the input file parameter
protected java.io.File	getParameterOutputFile(Parameterization config) Get the output file parameter.
protected java.io.File	getParameterOutputFile(Parameterization config, java.lang.String description) Get the output file parameter.
protected abstract AbstractApplication	makeInstance() Make an instance after successful configuration.
static void	parseDebugParameter(StringParameter param) Parse the option string to configure logging.

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer

configure, make, makeOptions

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_ID

public static final OptionID OUTPUT_ID

Parameter that specifies the name of the output file.

INPUT_ID

public static final OptionID INPUT_ID

Parameter that specifies the name of the input file.

DATABASE_ID

public static final OptionID DATABASE_ID

Option ID to specify the database type

HELP_ID

public static final OptionID HELP_ID

Flag to obtain help-message.

HELP_LONG_ID

public static final OptionID HELP_LONG_ID

Flag to obtain help-message.

DESCRIPTION_ID

public static final OptionID DESCRIPTION_ID

Optional Parameter to specify a class to obtain a description for.

DEBUG_ID

public static final OptionID DEBUG_ID

Optional Parameter to specify a class to enable debugging for.

VERBOSE_ID

public static final OptionID VERBOSE_ID

Flag to allow verbose messages while running the application.

Constructor Detail

Parameterizer

public Parameterizer()

Method Detail

getParameterOutputFile

protected java.io.File getParameterOutputFile(Parameterization config)

Get the output file parameter.

Parameters:

config - Options

Returns:

Output file

getParameterOutputFile

protected java.io.File getParameterOutputFile(Parameterization config,
                                              java.lang.String description)

Get the output file parameter.

Parameters:

config - Options

description - Short description

Returns:

Output file

getParameterInputFile

protected java.io.File getParameterInputFile(Parameterization config)

Get the input file parameter.

Parameters:

config - Options

Returns:

Input file

getParameterInputFile

protected java.io.File getParameterInputFile(Parameterization config,
                                             java.lang.String description)

Get the input file parameter

Parameters:

config - Options

description - Description

Returns:

Input file

parseDebugParameter

public static final void parseDebugParameter(StringParameter param)
                                      throws WrongParameterValueException

Parse the option string to configure logging.

Parameters:

param - Parameter to process.

Throws:

WrongParameterValueException - On parsing errors

makeInstance

protected abstract AbstractApplication makeInstance()

Description copied from class: AbstractParameterizer

Make an instance after successful configuration.

Specified by:

makeInstance in class AbstractParameterizer

Returns:

instance