org.hackystat.telemetry.analyzer.language.ast
Class TelemetryDefinition

java.lang.Object
  extended by org.hackystat.telemetry.analyzer.language.ast.TelemetryDefinition
Direct Known Subclasses:
DrawCommand, TelemetryChartDefinition, TelemetryChartYAxisDefinition, TelemetryReportDefinition, TelemetryStreamsDefinition

public abstract class TelemetryDefinition
extends java.lang.Object

Telemetry definition base class.

Version:
$Id$
Author:
(Cedric) Qin Zhang

Constructor Summary
protected TelemetryDefinition(java.lang.String name, TextPosition textPosition)
          Constucts this instance.
 
Method Summary
 java.lang.String getDefinitionString()
          Gets the definition string.
 java.lang.String getName()
          Gets the name of this telemetry "streams" object.
 TextPosition getTextPosition()
          Gets the text position of the definition string in the input.
 void setDefinitionString(java.lang.String definitionString)
          Sets the definition string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TelemetryDefinition

protected TelemetryDefinition(java.lang.String name,
                              TextPosition textPosition)
Constucts this instance.

Parameters:
name - The name of this definition.
textPosition - The text position of the definition string in the input.
Method Detail

getName

public java.lang.String getName()
Gets the name of this telemetry "streams" object.

Returns:
The name.

getTextPosition

public TextPosition getTextPosition()
Gets the text position of the definition string in the input.

Returns:
The text position of the definition string in the input.

getDefinitionString

public java.lang.String getDefinitionString()
Gets the definition string.

Returns:
The definition string, or null if the definition string is not available.

setDefinitionString

public void setDefinitionString(java.lang.String definitionString)
Sets the definition string.

Parameters:
definitionString - The description.