de.lmu.ifi.dbs.elki.algorithm

Class NullAlgorithm

java.lang.Object

de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm<Result>

de.lmu.ifi.dbs.elki.algorithm.NullAlgorithm

All Implemented Interfaces:

Algorithm, InspectionUtilFrequentlyScanned, Parameterizable

@Title(value="Null Algorithm")
@Description(value="Algorithm which does nothing, just return a null object.")
public class NullAlgorithm
extends AbstractAlgorithm<Result>

Null Algorithm, which does nothing. Can be used to e.g. just visualize a data set.

Field Summary

Fields

Modifier and Type	Field and Description
private static Logging	logger The logger for this class.

Constructor Summary

Constructors

Constructor and Description
NullAlgorithm() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
TypeInformation[]	getInputTypeRestriction() Get the input type restriction used for negotiating the data query.
protected Logging	getLogger() Get the (STATIC) logger for this class.
Result	run(Database database) Runs the algorithm.

Methods inherited from class de.lmu.ifi.dbs.elki.algorithm.AbstractAlgorithm

makeParameterDistanceFunction

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logging logger

The logger for this class.

Constructor Detail

NullAlgorithm

public NullAlgorithm()

Constructor.

Method Detail

run

public Result run(Database database)
           throws IllegalStateException

Description copied from interface: Algorithm

Runs the algorithm.

Specified by:

run in interface Algorithm

Overrides:

run in class AbstractAlgorithm<Result>

Parameters:

database - the database to run the algorithm on

Returns:

the Result computed by this algorithm

Throws:

IllegalStateException - if the algorithm has not been initialized properly (e.g. the setParameters(String[]) method has been failed to be called).

getLogger

protected Logging getLogger()

Description copied from class: AbstractAlgorithm

Get the (STATIC) logger for this class.

Specified by:

getLogger in class AbstractAlgorithm<Result>

Returns:

the static logger

getInputTypeRestriction

public TypeInformation[] getInputTypeRestriction()

Description copied from class: AbstractAlgorithm

Get the input type restriction used for negotiating the data query.

Specified by:

getInputTypeRestriction in interface Algorithm

Specified by:

getInputTypeRestriction in class AbstractAlgorithm<Result>

Returns:

Type restriction