com.ibm.etools.pd.widget.viewer
Class MeterDataRetriever

java.lang.Object
  |
  +--com.ibm.etools.pd.widget.viewer.DOMDataRetriever
        |
        +--com.ibm.etools.pd.widget.viewer.CommonDataRetriever
              |
              +--com.ibm.etools.pd.widget.viewer.MeterDataRetriever
All Implemented Interfaces:
IDataInputConstants, IDataInputProcessingExceptionCodes, java.io.Serializable

public class MeterDataRetriever
extends CommonDataRetriever

Data retrieval methods which retrieve data of interest to SVGMeter from documents which conform to the documented data input schemas.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.etools.pd.widget.viewer.CommonDataRetriever
configDocument, dataDocument
 
Fields inherited from interface com.ibm.etools.pd.widget.viewer.IDataInputProcessingExceptionCodes
CATEGORY_ID_MISMATCH, DUPLICATE_POSITION_NUMBER, INVALID_NUMBER_FORMAT, MAXIMUM_NUMBER_OF_SEGMENT_MARKERS_EXCEEDED, MISSING_CATEGORY_IDS_OR_DATAPOINT_VALUES, MISSING_CATEGORY_NAMES, MISSING_IDS_OR_POSITIONS, MISSING_NAMES_OR_POSITIONS, MISSING_PERCENTAGE_OF_DATAPOINT_TOTAL_OR_POSITION, MISSING_PERCENTAGES, MISSING_TOTALS, MISSING_TOTALS_OR_POSITIONS, MISSING_VALUES_OR_POSITIONS, NO_CONTEXT_FOUND, NO_DATA_DOCUMENT, NO_DATASETS_FOUND, NO_DESCRIPTION_FOUND, NO_IDS_FOUND, NO_NAMES_FOUND, NO_PERCENTAGE_OF_DATAPOINT_TOTAL_FOUND, NO_SUMMARY_FOUND, NO_TIMESTAMP_FOUND, NO_TOTALS_FOUND, NO_VALUE_FOUND, NO_VALUES_FOUND, POSITION_NUMBER_OUT_OF_BOUNDS
 
Fields inherited from interface com.ibm.etools.pd.widget.viewer.IDataInputConstants
ACTUAL_RATE, CATEGORIZATION, CATEGORY, CONFIGURATION, CONTEXT, DATAPOINT, DATASET, DATAUPDATE, DESCRIPTION, EMPTY_STRING, FONT, HEIGHT, ID, LEGEND_TITLE, MAXVALUE, MINVALUE, NAME, PERCENTAGE_OF_DATAPOINT_TOTAL, POSITION, RANGE, RATE_DEFINITION, SEGMENT_MARKER, SUMMARY, SUPPRESS_LEGEND, TIMESTAMP, TIMESTAMP_PREFIX, TITLE, TOTAL, TOTAL_TITLE, VALUE, VALUE_TITLE, WIDTH, X_TITLE, Y_TITLE
 
Method Summary
 java.util.Hashtable getLabels()
          Returns from the data document the text labels which indicate the contextual definition of the rate and its actual value, both of which are displayed by the meter graphic.
 java.lang.String getNeedleValue()
          Returns from the data document the value to which the meter needle points.
 
Methods inherited from class com.ibm.etools.pd.widget.viewer.CommonDataRetriever
getCategories, getCategoryIds, getCategoryTotals, getConfigurationAttributes, getDatapointValuesFromDatasetWithPosition, getDatapointValuesFromFirstDataset, getLegendLabels, getNumberOfDatasets, getRangeMarkers, getTimestamp, setConfigDocument, setDataDocument, throwException
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getLabels

public java.util.Hashtable getLabels()
                              throws DataInputProcessingException
Returns from the data document the text labels which indicate the contextual definition of the rate and its actual value, both of which are displayed by the meter graphic.

Throws:
DataInputProcessingException - for codes NO_DATA_DOCUMENT, NO_CONTEXT_FOUND, NO_SUMMARY_FOUND
See Also:
IDataInputProcessingExceptionCodes

getNeedleValue

public java.lang.String getNeedleValue()
                                throws DataInputProcessingException
Returns from the data document the value to which the meter needle points.

Throws:
DataInputProcessingException - for codes NO_DATA_DOCUMENT, NO_VALUE_FOUND, INVALID_NUMBER_FORMAT
See Also:
IDataInputProcessingExceptionCodes