|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.etools.pd.widget.viewer.DOMDataRetriever | +--com.ibm.etools.pd.widget.viewer.CommonDataRetriever
Common data retrieval methods which retrieve data of interest to SVGLineChart,
SVGBarChart, SVGStackBarChart, SVGPieChart
and SVGMeter
from
documents which conform to the documented data input schemas.
Field Summary | |
protected org.w3c.dom.Document |
configDocument
Document containing configuration data. |
protected org.w3c.dom.Document |
dataDocument
Document containing data update. |
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[] |
getCategories()
Returns the array of values which comprise the categories into which the data are assigned. |
java.lang.String[] |
getCategoryIds()
Returns an array of values, each of which uniquely identifies a category. |
java.lang.String[] |
getCategoryTotals()
Returns the array of values, each of which represents the sum of the data values within a category. |
java.util.Hashtable |
getConfigurationAttributes()
Returns the configuration attributes and values (if any) found in the configuration document. |
java.lang.String[] |
getDatapointValuesFromDatasetWithPosition(java.lang.String position)
Returns the array of data values for the data set with the specified position from the data document. |
java.lang.String[] |
getDatapointValuesFromFirstDataset()
Returns the array of data values from the first data set found in the data document. |
java.lang.String[] |
getLegendLabels()
Returns the ordered array of values found in the data document which comprise the legend. |
int |
getNumberOfDatasets()
Returns the number of data sets found in the data document. |
java.lang.String[] |
getRangeMarkers()
Returns the array of values which mark the segments into which the data range is divided. |
java.lang.String |
getTimestamp()
Returns the timestamp found in the data document. |
void |
setConfigDocument(org.w3c.dom.Document newConfigDocument)
Sets the document which contains the configuration data. |
void |
setDataDocument(org.w3c.dom.Document newDataDocument)
Sets the document which contains the data update and may contain configuration data; however,only in the event that configDocument
is null will configuration data be retrieved from this document. |
protected void |
throwException(short code,
java.lang.String element)
Convenience method for throwing exceptions. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected org.w3c.dom.Document configDocument
protected org.w3c.dom.Document dataDocument
Method Detail |
public void setConfigDocument(org.w3c.dom.Document newConfigDocument)
newConfigDocument
- the configuration data documentpublic void setDataDocument(org.w3c.dom.Document newDataDocument)
configDocument
is null
will configuration data be retrieved from this document.
newDataDocument
- the document providing data updatespublic int getNumberOfDatasets() throws DataInputProcessingException
DataInputProcessingException
- for codes NO_DATA_DOCUMENT,
NO_DATASETS_FOUND
.public java.util.Hashtable getConfigurationAttributes() throws DataInputProcessingException
DataInputProcessingException
- for code NO_DATA_DOCUMENT
.public java.lang.String[] getLegendLabels() throws DataInputProcessingException
DataInputProcessingException
- for codes NO_DATA_DOCUMENT, NO_NAMES_FOUND, MISSING_NAMES_OR_POSITIONS,
POSITION_NUMBER_OUT_OF_BOUNDS, DUPLICATE_POSITION_NUMBER, INVALID_NUMBER_FORMAT
public java.lang.String getTimestamp() throws DataInputProcessingException
DataInputProcessingException
- for code NO_DATA_DOCUMENT, NO_TIMESTAMP_FOUND
.public java.lang.String[] getRangeMarkers() throws DataInputProcessingException
DataInputProcessingException
- for codes NO_DATA_DOCUMENT, NO_VALUES_FOUND, MISSING_VALUES_OR_POSITIONS,
POSITION_NUMBER_OUT_OF_BOUNDS, DUPLICATE_POSITION_NUMBER, INVALID_NUMBER_FORMAT
public java.lang.String[] getCategories() throws DataInputProcessingException
DataInputProcessingException
- for codes NO_DATA_DOCUMENT, NO_NAMES_FOUND, MISSING_NAMES_OR_POSITIONS,
POSITION_NUMBER_OUT_OF_BOUNDS, DUPLICATE_POSITION_NUMBER, INVALID_NUMBER_FORMAT
public java.lang.String[] getCategoryIds() throws DataInputProcessingException
DataInputProcessingException
- for codes NO_DATA_DOCUMENT, NO_IDS_FOUND, MISSING_IDS_OR_POSITIONS,
POSITION_NUMBER_OUT_OF_BOUNDS, DUPLICATE_POSITION_NUMBER, INVALID_NUMBER_FORMAT
public java.lang.String[] getCategoryTotals() throws DataInputProcessingException
DataInputProcessingException
- for codes NO_DATA_DOCUMENT, NO_TOTALS_FOUND, MISSING_TOTALS_OR_POSITIONS,
POSITION_NUMBER_OUT_OF_BOUNDS, DUPLICATE_POSITION_NUMBER, INVALID_NUMBER_FORMAT
public java.lang.String[] getDatapointValuesFromDatasetWithPosition(java.lang.String position) throws DataInputProcessingException
DataInputProcessingException
- for codes NO_DATA_DOCUMENT, NO_VALUES_FOUND, NO_IDS_FOUND,
MISSING_CATEGORY_IDS_OR_DATAPOINT_VALUES, CATEGORY_ID_MISMATCH, INVALID_NUMBER_FORMAT
public java.lang.String[] getDatapointValuesFromFirstDataset() throws DataInputProcessingException
DataInputProcessingException
- for codes NO_DATA_DOCUMENT, NO_VALUES_FOUND, NO_IDS_FOUND,
MISSING_CATEGORY_IDS_OR_DATAPOINT_VALUES, CATEGORY_ID_MISMATCH, INVALID_NUMBER_FORMAT
protected void throwException(short code, java.lang.String element) throws DataInputProcessingException
DataInputProcessingException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |