org.eclipse.birt.chart.datafeed
Interface IDataSetProcessor

All Known Implementing Classes:
DataSetAdapter

public interface IDataSetProcessor

Provides a generic definition of a data set processor capable of building or scanning through data sets associated with specific series types.


Method Summary
 DataSet fromString(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.lang.String getExpectedStringFormat()
           
 java.util.Locale getLocale()
          Deprecated. use getULocale() instead.
 java.lang.Object getMaximum(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.Object getMinimum(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.ULocale getULocale()
          Provides the locale to device renderer implementations as needed to retrieve localized resources for presentation.
 DataSet populate(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 execution
 java.lang.String toString(java.lang.Object[] columnData)
          Attempts to format a column of data to string.
 

Method Detail

fromString

public DataSet fromString(java.lang.String sDataSetRepresentation,
                          DataSet ds)
                   throws ChartException
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.

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

toString

public java.lang.String toString(java.lang.Object[] columnData)
                          throws ChartException
Attempts to format a column of data to string. For example, an array Object[Double(1), Double(2)] will be converted into String "1,2"

Parameters:
columnData - array of column data. All elements have same class type.
Throws:
ChartException

getExpectedStringFormat

public java.lang.String getExpectedStringFormat()
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

populate

public DataSet populate(java.lang.Object oResultSetDef,
                        DataSet ds)
                 throws ChartException
Populates a data set with data element values retrieved from a result set created as a result of query execution

Parameters:
oResultSetDef - An instance of a generic result set that is host application specific. For BIRT, the result set class is ResultSetDataSet
ds - 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
Causes implementation specific data set processor classes to compute the minimum value in a data set of a specific series type.

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
Causes implementation specific data set processor classes to compute the maximum value in a data set of a specific series type.

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

getLocale

public java.util.Locale getLocale()
Deprecated. use getULocale() instead.

Provides the locale to device renderer implementations as needed to retrieve localized resources for presentation.

Returns:
The locale to be used

getULocale

public com.ibm.icu.util.ULocale getULocale()
Provides the locale to device renderer implementations as needed to retrieve localized resources for presentation.

Returns:
The locale to be used
Since:
2.1


Copyright © 2005 Actuate Corp. All rights reserved.