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

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
                  de.lmu.ifi.dbs.elki.application.StandAloneInputApplication

All Implemented Interfaces:

Parameterizable

public abstract class StandAloneInputApplication
extends StandAloneApplication

StandAloneInputApplication extends StandAloneApplication and sets additionally the parameter in. Any Application class that makes use of these flags may extend this class.

Author:

Elke Achtert

Field Summary

private File	input Holds the value of INPUT_PARAM.
static OptionID	INPUT_ID OptionID for INPUT_PARAM
private FileParameter	INPUT_PARAM Parameter that specifies the name of the input file.

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

OUTPUT_ID

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

StandAloneInputApplication() Adds parameter INPUT_PARAM to the option handler additionally to parameters of super class.

Method Summary

File	getInput() Returns the input file.
abstract String	getInputDescription() Returns the description for the input parameter.
List<String>	setParameters(List<String> args) Calls the super method and sets additionally the value of the parameter INPUT_PARAM.

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

getOutput, getOutputDescription

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

INPUT_ID

public static final OptionID INPUT_ID

OptionID for INPUT_PARAM

INPUT_PARAM

private final FileParameter INPUT_PARAM

Parameter that specifies the name of the input file.

Key: -app.in

input

private File input

Holds the value of INPUT_PARAM.

Constructor Detail

StandAloneInputApplication

protected StandAloneInputApplication()

Adds parameter INPUT_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 INPUT_PARAM.

Specified by:

setParameters in interface Parameterizable

Overrides:

setParameters in class StandAloneApplication

Parameters:

args - parameters to set the attributes accordingly to

Returns:

a list containing the unused parameters

Throws:

ParameterException - in case of wrong parameter-setting

getInput

public final File getInput()

Returns the input file.

Returns:

the input file

getInputDescription

public abstract String getInputDescription()

Returns the description for the input parameter.

Returns:

the description for the input parameter