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

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

public class PieChartDataRetriever
extends CommonDataRetriever

Data retrieval methods which retrieve data of interest to SVGPieChart 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.lang.String[] getDatasetPercentages()
          Returns the ordered array of values found in the data document each of which represents the total value of a data set as a percentage of the sum of the total values of all the data sets.
 java.lang.String[] getDatasetTotals()
          Returns the ordered array of values found in the data document each of which represents the total value of a data set and each is rendered as a pie slice value.
 java.util.Hashtable getTitles()
          Returns from the data document the text labels which indicate the contextual definition of the data values and the summary (total value) for the pie, both of which are displayed by the meter graphic.
 
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

getTitles

public java.util.Hashtable getTitles()
                              throws DataInputProcessingException
Returns from the data document the text labels which indicate the contextual definition of the data values and the summary (total value) for the pie, 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

getDatasetTotals

public java.lang.String[] getDatasetTotals()
                                    throws DataInputProcessingException
Returns the ordered array of values found in the data document each of which represents the total value of a data set and each is rendered as a pie slice value. Values can be ordered by specifying their ordinal position; otherwise, the retrieved (document) order is used.

Throws:
DataInputProcessingException - for codes NO_DATA_DOCUMENT, NO_TOTALS_FOUND, MISSING_TOTALS_OR_POSITIONS, POSITION_NUMBER_OUT_OF_BOUNDS, DUPLICATE_POSITION_NUMBER, INVALID_NUMBER_FORMAT
See Also:
IDataInputProcessingExceptionCodes

getDatasetPercentages

public java.lang.String[] getDatasetPercentages()
                                         throws DataInputProcessingException
Returns the ordered array of values found in the data document each of which represents the total value of a data set as a percentage of the sum of the total values of all the data sets. Each of these values is rendered as a pie slice percentage value. Values can be ordered by specifying their ordinal position; otherwise, the retrieved (document) order is used.

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