org.n52.math
Class AbstractAlgorithm

java.lang.Object
  org.n52.math.AbstractAlgorithm

All Implemented Interfaces:

Algorithm

Direct Known Subclasses:

NdviAlgorithm, RadianceFromDN, ReflectanceAlgorithm, SmacAlgorithm

public abstract class AbstractAlgorithm
extends java.lang.Object
implements Algorithm

Convenience class to implement Algorithm.

Author:

Wim Koolhoven

Constructor Summary

protected	AbstractAlgorithm(java.lang.String name, java.lang.String description) To set name and description.
protected	AbstractAlgorithm(java.lang.String name, java.lang.String description, java.lang.String[] paramNames, java.lang.String[] paramDescr) To specify name, description, param names and descriptions.

Method Summary

java.lang.String	getDescription() may return the Description of the Algorithm.
java.lang.String	getDocURL() may return an URL to Documentation about the Algorithm.
java.lang.String	getName() returns the Name of the Algorithm.
int	getNrParams() returns the number of parameters
java.lang.String	getParamDescription(int paramNr) may return a Description of the parameter.
java.lang.String	getParamName(int paramNr) returns the Name of the parameter
java.lang.String	getVersion() may return the version of the Algorithm.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.n52.math.Algorithm

calculate

Constructor Detail

AbstractAlgorithm

protected AbstractAlgorithm(java.lang.String name,
                            java.lang.String description)

To set name and description.

Parameters:

name - the Algorithm name, to be returned by getName()

description - the Algorithm description, to be returned by getDescription()

AbstractAlgorithm

protected AbstractAlgorithm(java.lang.String name,
                            java.lang.String description,
                            java.lang.String[] paramNames,
                            java.lang.String[] paramDescr)

To specify name, description, param names and descriptions. getNrParams() is based on paramNames.

Parameters:

name - the Algorithm name, to be returned by getName()

description - the Algorithm description, to be returned by getDescription()

paramNames - the parameter Names, to be returned by getParamName(int)

paramDescr - the paramerer Descriptions, to be returned by getParamDescription(int)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Algorithm

returns the Name of the Algorithm. This may not be NULL.

Specified by:

getName in interface Algorithm

getDescription

public java.lang.String getDescription()

Description copied from interface: Algorithm

may return the Description of the Algorithm. Intended to give the end user more information.

Specified by:

getDescription in interface Algorithm

getDocURL

public java.lang.String getDocURL()

Description copied from interface: Algorithm

may return an URL to Documentation about the Algorithm. Intended to show this documentation when the end user asks for help.

Specified by:

getDocURL in interface Algorithm

getVersion

public java.lang.String getVersion()

Description copied from interface: Algorithm

may return the version of the Algorithm.

Specified by:

getVersion in interface Algorithm

getNrParams

public int getNrParams()

Description copied from interface: Algorithm

returns the number of parameters

Specified by:

getNrParams in interface Algorithm

getParamName

public java.lang.String getParamName(int paramNr)

Description copied from interface: Algorithm

returns the Name of the parameter

Specified by:

getParamName in interface Algorithm

Parameters:

paramNr - starts counting at 0

Returns:

the Name of parameter paramNr

getParamDescription

public java.lang.String getParamDescription(int paramNr)

Description copied from interface: Algorithm

may return a Description of the parameter. Intended to give the end user more information.

Specified by:

getParamDescription in interface Algorithm

Parameters:

paramNr - starts counting at 0

Returns:

the Name of parameter paramNr