Package org.eclipse.birt.chart.datafeed
Class DataSetAdapter
- java.lang.Object
-
- org.eclipse.birt.chart.computation.Methods
-
- org.eclipse.birt.chart.datafeed.DataSetAdapter
-
- All Implemented Interfaces:
IConstants,IDataSetProcessor
public class DataSetAdapter extends Methods implements IDataSetProcessor
Provides a no-op implementation of theIDataSetProcessorinterface definition to be subclassed by each extension writer as needed.
-
-
Field Summary
-
Fields inherited from interface org.eclipse.birt.chart.computation.IConstants
ABOVE, ANCILLARY_AXIS, ANCILLARY_BASE, ARRAY, AUTO, AVERAGE, AXIS, BACKWARD, BASE, BASE_AXIS, BELOW, BIG_NUMBER_PRIMITIVE_ARRAY, BOOLEAN, BOTTOM, CENTER, COLLECTION, DATE_TIME, DESIGN_TIME, EMPTY_STRING, EQUAL, FORWARD, HORIZONTAL, INSIDE, LABELS, LEFT, LEGEND_ENTRY, LEGEND_GROUP_NAME, LEGEND_MINSLICE_ENTRY, LEGEND_SEPERATOR, LESS, LINE_EXPAND_DOUBLE_SIZE, LINE_EXPAND_SIZE, LINEAR, LOG_10, LOGARITHMIC, MAJOR, MAX, MIN, MINOR, MORE, NON_PRIMITIVE_ARRAY, NULL_STRING, NUMBER_PRIMITIVE_ARRAY, NUMERICAL, ONE_SPACE, ORTHOGONAL, ORTHOGONAL_AXIS, OTHER, OUTSIDE, PERCENT, POSITION_MASK, POSITION_MOVE_ABOVE, POSITION_MOVE_BELOW, POSITION_MOVE_LEFT, POSITION_MOVE_RIGHT, PRIMITIVE_ARRAY, RIGHT, RUN_TIME, SOME_NULL, TEXT, THREE_D, TICK_ABOVE, TICK_ACROSS, TICK_BELOW, TICK_LEFT, TICK_NONE, TICK_RIGHT, TICK_SIDE1, TICK_SIDE2, TICK_SIZE, TOP, TWO_5_D, TWO_D, UNDEFINED, UNDEFINED_STRING, USER_INTERFACE, VALUE, VERTICAL
-
-
Constructor Summary
Constructors Constructor Description DataSetAdapter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataSetfromString(java.lang.String sDataSetRepresentation, DataSet ds)Attempts to parse a line of text representing multiple values of a specific data element type and updates an existing data set or creates a new data set filled with these values.java.util.List<Query>getDataDefinitionsForGrouping(Series series)Provides a list of data definitions for grouping.java.lang.StringgetExpectedStringFormat()java.util.LocalegetLocale()Provides the locale to device renderer implementations as needed to retrieve localized resources for presentation.java.lang.ObjectgetMaximum(DataSet ds)Causes implementation specific data set processor classes to compute the maximum value in a data set of a specific series type.java.lang.ObjectgetMinimum(DataSet ds)Causes implementation specific data set processor classes to compute the minimum value in a data set of a specific series type.com.ibm.icu.util.ULocalegetULocale()Provides the locale to device renderer implementations as needed to retrieve localized resources for presentation.DataSetpopulate(java.lang.Object oResultSetDef, DataSet ds)Populates a data set with data element values retrieved from a result set created as a result of query executionvoidsetLocale(com.ibm.icu.util.ULocale lcl)A convenience method provided to associate a locale with a display serverjava.lang.StringtoString(java.lang.Object[] columnData)Attempts to format a column of data to string.-
Methods inherited from class org.eclipse.birt.chart.computation.Methods
asDateTime, asDouble, asInteger, computeBox, computeBox, computeBox, computeBox, computeFontHeight, computeHeight, computeHeight, computeLabelSize, computePolygon, computePolygon, computePolygon, computeRotatedTopPoint, computeWidth, computeWidth, getLabelPosition, getLocation, getLocation, getLocation, getNormalizedLocation, getNormalizedLocation
-
-
-
-
Method Detail
-
fromString
public DataSet fromString(java.lang.String sDataSetRepresentation, DataSet ds) throws ChartException
Description copied from interface:IDataSetProcessorAttempts to parse a line of text representing multiple values of a specific data element type and updates an existing data set or creates a new data set filled with these values.- Specified by:
fromStringin interfaceIDataSetProcessor- Parameters:
sDataSetRepresentation- A line of text containing a list of data element values that may be parsed.ds- An existing data set (or null for a new one) that needs to be filled with data elements created by parsing the line of text as per the expected string format.- Returns:
- The existing data set definition passed in as an argument or a new one if the 'ds' argument was null
- Throws:
ChartException
-
populate
public DataSet populate(java.lang.Object oResultSetDef, DataSet ds) throws ChartException
Description copied from interface:IDataSetProcessorPopulates a data set with data element values retrieved from a result set created as a result of query execution- Specified by:
populatein interfaceIDataSetProcessor- Parameters:
oResultSetDef- An instance of a generic result set that is host application specific. For BIRT, the result set class is ResultSetDataSetds- An existing data set (or null for a new one) that needs to be filled with with data elements extracted from the result set definition- Returns:
- The existing data set definition passed in as an argument or a new one if the 'ds' argument was null
- Throws:
ChartException
-
getMinimum
public java.lang.Object getMinimum(DataSet ds) throws ChartException
Description copied from interface:IDataSetProcessorCauses implementation specific data set processor classes to compute the minimum value in a data set of a specific series type.- Specified by:
getMinimumin interfaceIDataSetProcessor- Parameters:
ds- The data set for which the minimum value needs to be computed- Returns:
- The minimum value found in the data set
- Throws:
ChartException
-
getMaximum
public java.lang.Object getMaximum(DataSet ds) throws ChartException
Description copied from interface:IDataSetProcessorCauses implementation specific data set processor classes to compute the maximum value in a data set of a specific series type.- Specified by:
getMaximumin interfaceIDataSetProcessor- Parameters:
ds- The data set for which the maximum value needs to be computed- Returns:
- The maximum value found in the data set
- Throws:
ChartException
-
getExpectedStringFormat
public java.lang.String getExpectedStringFormat()
- Specified by:
getExpectedStringFormatin interfaceIDataSetProcessor- Returns:
- The expected format of a line of text that will be used by the fromString(...) method to parse and create data elements to be populated into a data set
-
getLocale
public java.util.Locale getLocale()
Description copied from interface:IDataSetProcessorProvides the locale to device renderer implementations as needed to retrieve localized resources for presentation.- Specified by:
getLocalein interfaceIDataSetProcessor- Returns:
- The locale to be used
-
getULocale
public com.ibm.icu.util.ULocale getULocale()
Description copied from interface:IDataSetProcessorProvides the locale to device renderer implementations as needed to retrieve localized resources for presentation.- Specified by:
getULocalein interfaceIDataSetProcessor- Returns:
- The locale to be used
-
setLocale
public final void setLocale(com.ibm.icu.util.ULocale lcl)
A convenience method provided to associate a locale with a display server- Parameters:
lcl- The locale to be set
-
toString
public java.lang.String toString(java.lang.Object[] columnData) throws ChartExceptionDescription copied from interface:IDataSetProcessorAttempts to format a column of data to string. For example, an array Object[Double(1), Double(2)] will be converted into String "1,2"- Specified by:
toStringin interfaceIDataSetProcessor- Parameters:
columnData- array of column data. All elements have same class type.- Throws:
ChartException
-
getDataDefinitionsForGrouping
public java.util.List<Query> getDataDefinitionsForGrouping(Series series)
Description copied from interface:IDataSetProcessorProvides a list of data definitions for grouping. The data after evaluating will be aggregated by aggregation expression.- Specified by:
getDataDefinitionsForGroupingin interfaceIDataSetProcessor- Parameters:
series- series to get data definitions- Returns:
- a list of data definitions for grouping
-
-