Package elki.application

Class AbstractApplication.Par

java.lang.Object

elki.application.AbstractApplication.Par

All Implemented Interfaces:

Parameterizer

Direct Known Subclasses:

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

Enclosing class:

AbstractApplication

public abstract static class AbstractApplication.Par
extends java.lang.Object
implements Parameterizer

Parameterization class.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field	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	Description
Par()

Method Summary

Modifier and Type	Method	Description
static void	applyLoggingLevels(java.lang.String[][] levels)	Apply the logging levels.
protected java.net.URI	getParameterInputFile(Parameterization config)	Get the input file parameter.
protected java.net.URI	getParameterInputFile(Parameterization config, java.lang.String description)	Get the input file parameter
protected java.nio.file.Path	getParameterOutputFile(Parameterization config)	Get the output file parameter.
protected java.nio.file.Path	getParameterOutputFile(Parameterization config, java.lang.String description)	Get the output file parameter.
abstract AbstractApplication	make()	Make an instance after successful configuration.
static java.lang.String[][]	parseDebugParameter(Parameterization config)	Parse the standard -debug parameter.
static java.util.logging.Level	parseVerbose(Parameterization config)	Parse the standard -verbose options.

Methods inherited from class java.lang.Object

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

Methods inherited from interface elki.utilities.optionhandling.Parameterizer

configure

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

Par

public Par()

Method Detail

parseVerbose

public static java.util.logging.Level parseVerbose(Parameterization config)

Parse the standard -verbose options.

Parameters:

config - Parameterization

parseDebugParameter

public static java.lang.String[][] parseDebugParameter(Parameterization config)

Parse the standard -debug parameter.

Parameters:

config - Parameterization

Returns:

Levels to set, or null

applyLoggingLevels

public static void applyLoggingLevels(java.lang.String[][] levels)

Apply the logging levels.

Parameters:

levels - Logging levels, may be null.

getParameterOutputFile

protected java.nio.file.Path getParameterOutputFile(Parameterization config)

Get the output file parameter.

Parameters:

config - Options

Returns:

Output file

getParameterOutputFile

protected java.nio.file.Path getParameterOutputFile(Parameterization config,
                                                    java.lang.String description)

Get the output file parameter.

Parameters:

config - Options

description - Short description

Returns:

Output file

getParameterInputFile

protected java.net.URI getParameterInputFile(Parameterization config)

Get the input file parameter.

Parameters:

config - Options

Returns:

Input file

getParameterInputFile

protected java.net.URI getParameterInputFile(Parameterization config,
                                             java.lang.String description)

Get the input file parameter

Parameters:

config - Options

description - Description

Returns:

Input file

make

public abstract AbstractApplication make()

Description copied from interface: Parameterizer

Make an instance after successful configuration.

Note: your class should return the exact type, only this very broad interface should use Object as return type.

Specified by:

make in interface Parameterizer

Returns:

a new instance