Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

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

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      extended by de.lmu.ifi.dbs.elki.application.AbstractApplication
          extended by de.lmu.ifi.dbs.elki.application.StandAloneApplication
              extended by 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
config, INFORMATION, STATIC_LOGGER
 
Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable
debug, logger
 
Constructor Summary
protected StandAloneInputApplication(Parameterization config)
          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.
 
Methods inherited from class de.lmu.ifi.dbs.elki.application.StandAloneApplication
getOutput, getOutputDescription
 
Methods inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication
isVerbose, printErrorMessage, run, runCLIApplication, usage
 
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(Parameterization config)
Adds parameter INPUT_PARAM to the option handler additionally to parameters of super class.

Method Detail

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

Release 0.3 (2010-03-31_1612)