de.lmu.ifi.dbs.elki.application
Class StandAloneApplication

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          de.lmu.ifi.dbs.elki.application.AbstractApplication
              de.lmu.ifi.dbs.elki.application.StandAloneApplication

All Implemented Interfaces:

Parameterizable

Direct Known Subclasses:

GeneratorXMLSpec, StandAloneInputApplication

public abstract class StandAloneApplication
extends AbstractApplication

StandAloneApplication sets additionally to the flags set by AbstractApplication the output parameter out.

Any Application class that makes use of these flags may extend this class. Beware to make correct use of parameter settings via optionHandler as commented with constructor and methods.

Author:

Elke Achtert

Field Summary

private File	output Holds the value of OUTPUT_PARAM.
static OptionID	OUTPUT_ID OptionID for OUTPUT_PARAM
private FileParameter	OUTPUT_PARAM Parameter that specifies the name of the output file.

Fields inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication

INFORMATION

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable

optionHandler

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug, logger

Constructor Summary

protected

StandAloneApplication() Adds parameter OUTPUT_PARAM to the option handler additionally to parameters of super class.

Method Summary

File	getOutput() Returns the output string.
abstract String	getOutputDescription() Returns the description for the output parameter.
List<String>	setParameters(List<String> args) Calls the super method and sets additionally the value of the parameter OUTPUT_PARAM.

Methods inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication

getRemainingParameters, isVerbose, run, runCLIApplication, usage

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

addOption, addParameterizable, addParameterizable, checkGlobalParameterConstraints, collectOptions, getAttributeSettings, getParameters, rememberParametersExcept, removeOption, removeParameterizable, shortDescription

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, progress, verbose, warning

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

OptionID for OUTPUT_PARAM

OUTPUT_PARAM

private final FileParameter OUTPUT_PARAM

Parameter that specifies the name of the output file.

Key: -app.out

output

private File output

Holds the value of OUTPUT_PARAM.

Constructor Detail

StandAloneApplication

protected StandAloneApplication()

Adds parameter OUTPUT_PARAM to the option handler additionally to parameters of super class.

Method Detail

setParameters

public List<String> setParameters(List<String> args)
                           throws ParameterException

Calls the super method and sets additionally the value of the parameter OUTPUT_PARAM.

Specified by:

setParameters in interface Parameterizable

Overrides:

setParameters in class AbstractApplication

Parameters:

args - parameters to set the attributes accordingly to

Returns:

a list containing the unused parameters

Throws:

ParameterException - in case of wrong parameter-setting

getOutput

public final File getOutput()

Returns the output string.

Returns:

the output string

getOutputDescription

public abstract String getOutputDescription()

Returns the description for the output parameter.

Returns:

the description for the output parameter