org.hackystat.telemetry.analyzer.function
Class TelemetryFunctionInfo

java.lang.Object
  extended by org.hackystat.telemetry.analyzer.function.TelemetryFunctionInfo

public class TelemetryFunctionInfo
extends java.lang.Object

Provides information about a specific implementation of a TelemetryFunction.

Author:
(Cedric) Qin Zhang, Philip Johnson

Constructor Summary
TelemetryFunctionInfo(TelemetryFunction function, FunctionDefinition definition)
          Constructs this instance.
 
Method Summary
 TelemetryFunction getFunction()
          Gets the instance of the telemetry function.
 java.lang.String getFunctionDescription()
          Gets the description of this function.
 java.lang.String getName()
          Gets the name of the telemetry function.
 Parameters getParameterDescription()
          Gets the description of the parameters this function takes if any.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TelemetryFunctionInfo

TelemetryFunctionInfo(TelemetryFunction function,
                      FunctionDefinition definition)
Constructs this instance.

Parameters:
function - The concrete instance of telemetry function.
definition - The definition of this function, from the JAXB XML class.
Method Detail

getName

public java.lang.String getName()
Gets the name of the telemetry function.

Returns:
The name.

getFunction

public TelemetryFunction getFunction()
Gets the instance of the telemetry function.

Returns:
The instance.

getFunctionDescription

public java.lang.String getFunctionDescription()
Gets the description of this function.

Returns:
The description of the function.

getParameterDescription

public Parameters getParameterDescription()
Gets the description of the parameters this function takes if any.

Returns:
The description of the parameters.