de.lmu.ifi.dbs.elki
Class KDDTask<O extends DatabaseObject>

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.KDDTask<O>

Type Parameters:

O - the type of DatabaseObjects handled by this Algorithm

All Implemented Interfaces:

Parameterizable

public class KDDTask<O extends DatabaseObject>
extends AbstractApplication

Provides a KDDTask that can be used to perform any algorithm implementing Algorithm using any DatabaseConnection implementing DatabaseConnection.

Author:

Arthur Zimek

Field Summary

private Algorithm<O,Result>	algorithm Holds the algorithm to run.
private ClassParameter<Algorithm<O,Result>>	ALGORITHM_PARAM Parameter to specify the algorithm to be applied, must extend Algorithm.
private ClassParameter<DatabaseConnection<O>>	DATABASE_CONNECTION_PARAM Parameter to specify the database connection to be used, must extend DatabaseConnection.
private DatabaseConnection<O>	databaseConnection Holds the database connection to have the algorithm run with.
private Normalization<O>	normalization A normalization - per default no normalization is used.
private ClassParameter<Normalization<O>>	NORMALIZATION_PARAM Optional Parameter to specify a normalization in order to use a database with normalized values.
private Flag	NORMALIZATION_UNDO_FLAG Flag to revert result to original values - invalid option if no normalization has been performed.
private boolean	normalizationUndo Whether to undo normalization for result.
(package private) MultiResult	result Store the result.
private ClassParameter<ResultHandler<O,Result>>	RESULT_HANDLER_PARAM Parameter to specify the result handler to be used, must extend ResultHandler.
private ResultHandler<O,Result>	resulthandler Output handler.

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

KDDTask()
Provides a KDDTask.

Method Summary

MultiResult	getResult() Get the algorithms result.
static void	main(String[] args) Runs a KDD task accordingly to the specified parameters.
void	run() Method to run the specified algorithm using the specified database connection.
List<String>	setParameters(List<String> args) Grabs all specified options from the option handler.

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

getRemainingParameters, isVerbose, 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

ALGORITHM_PARAM

private final ClassParameter<Algorithm<O extends DatabaseObject,Result>> ALGORITHM_PARAM

Parameter to specify the algorithm to be applied, must extend Algorithm.

Key: -algorithm

DATABASE_CONNECTION_PARAM

private final ClassParameter<DatabaseConnection<O extends DatabaseObject>> DATABASE_CONNECTION_PARAM

Parameter to specify the database connection to be used, must extend DatabaseConnection.

Key: -dbc

Default value: FileBasedDatabaseConnection

NORMALIZATION_PARAM

private final ClassParameter<Normalization<O extends DatabaseObject>> NORMALIZATION_PARAM

Optional Parameter to specify a normalization in order to use a database with normalized values.

Key: -norm

NORMALIZATION_UNDO_FLAG

private final Flag NORMALIZATION_UNDO_FLAG

Flag to revert result to original values - invalid option if no normalization has been performed.

Key: -normUndo

RESULT_HANDLER_PARAM

private final ClassParameter<ResultHandler<O extends DatabaseObject,Result>> RESULT_HANDLER_PARAM

Parameter to specify the result handler to be used, must extend ResultHandler.

Key: -resulthandler

Default value: ResultWriter

algorithm

private Algorithm<O extends DatabaseObject,Result> algorithm

Holds the algorithm to run.

databaseConnection

private DatabaseConnection<O extends DatabaseObject> databaseConnection

Holds the database connection to have the algorithm run with.

normalization

private Normalization<O extends DatabaseObject> normalization

A normalization - per default no normalization is used.

normalizationUndo

private boolean normalizationUndo

Whether to undo normalization for result.

resulthandler

private ResultHandler<O extends DatabaseObject,Result> resulthandler

Output handler.

result

MultiResult result

Store the result.

Constructor Detail

KDDTask

public KDDTask()

Provides a KDDTask.

Method Detail

setParameters

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

Description copied from class: AbstractParameterizable

Grabs all specified options from the option handler. Any extending class should call this method first and return the returned array without further changes, but after setting further required parameters. An example for overwriting this method taking advantage from the previously (in superclasses) defined options would be:

 {
   List remainingParameters = super.setParameters(args);
   // set parameters for your class
   // for example like this:
   if(isSet(MY_PARAM_VALUE_PARAM))
   {
      myParamValue = getParameterValue(MY_PARAM_VALUE_PARAM);
   }
   .
   .
   .
   return remainingParameters;
   // or in case of attributes requesting parameters themselves
   // return parameterizableAttribbute.setParameters(remainingParameters);
 }
 

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

See Also:

AbstractParameterizable.setParameters(java.util.List)

run

public void run()
         throws IllegalStateException

Method to run the specified algorithm using the specified database connection.

Specified by:

run in class AbstractApplication

Throws:

IllegalStateException

getResult

public MultiResult getResult()

Get the algorithms result.

Returns:

the result

main

public static void main(String[] args)

Runs a KDD task accordingly to the specified parameters.

Parameters:

args - parameter list according to description