|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hackystat.telemetry.analyzer.function.TelemetryFunction
public abstract class TelemetryFunction
Provides an abstract base class for telemetry functions.
A telemetry function operates on an array of
Number
and/or TelemetryStreamCollection
objects, and
returns either a Number
or a TelemetryStreamCollection
object.
Constructor Summary | |
---|---|
protected |
TelemetryFunction(java.lang.String name)
Constructs this instance. |
Method Summary | |
---|---|
abstract java.lang.Object |
compute(java.lang.Object[] parameters)
Invokes the function. |
java.lang.String |
getName()
The name of this function. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected TelemetryFunction(java.lang.String name)
name
- The assigned name of this function.Method Detail |
---|
public java.lang.String getName()
public abstract java.lang.Object compute(java.lang.Object[] parameters) throws TelemetryFunctionException
parameters
- An array of objects of type either String
,
Number
, and/or TelemetryStreamCollection
.
Note: Since telemetry chart analyses might pass in parameter values as Strings,
the implementation should be prepared to handle Strings even if it is expecting
a number instance.
Number
or TelemetryStreamCollection
.
TelemetryFunctionException
- If anything is wrong.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |