|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.n52.math.AbstractAlgorithm
public abstract class AbstractAlgorithm
Convenience class to implement Algorithm
.
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 |
---|
protected AbstractAlgorithm(java.lang.String name, java.lang.String description)
name
- the Algorithm name, to be returned by getName()
description
- the Algorithm description, to be returned by getDescription()
protected AbstractAlgorithm(java.lang.String name, java.lang.String description, java.lang.String[] paramNames, java.lang.String[] paramDescr)
getNrParams()
is based on paramNames
.
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 |
---|
public java.lang.String getName()
Algorithm
getName
in interface Algorithm
public java.lang.String getDescription()
Algorithm
getDescription
in interface Algorithm
public java.lang.String getDocURL()
Algorithm
getDocURL
in interface Algorithm
public java.lang.String getVersion()
Algorithm
getVersion
in interface Algorithm
public int getNrParams()
Algorithm
getNrParams
in interface Algorithm
public java.lang.String getParamName(int paramNr)
Algorithm
getParamName
in interface Algorithm
paramNr
- starts counting at 0
paramNr
public java.lang.String getParamDescription(int paramNr)
Algorithm
getParamDescription
in interface Algorithm
paramNr
- starts counting at 0
paramNr
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |