org.eclipse.birt.chart.ui.swt.interfaces
Interface IDataServiceProvider


public interface IDataServiceProvider

Data service provider for chart wizard, to provide all necessary data.


Field Summary
static int DATA_BINDING_REFERENCE
           
static int HAS_CUBE
           
static int HAS_DATA_SET
           
static int IN_MULTI_VIEWS
           
static int INHERIT_COLUMNS_GROUPS
           
static int INHERIT_COLUMNS_ONLY
           
static int MULTI_CUBE_DIMENSIONS
          Indicates if current chart is using cube or sharing with crosstab or in multi-view, and cube's dimension count > 1.
static int PART_CHART
          Indicates if current chart is a part of whole chart, such as plot or axis.
static int SHARE_CHART_QUERY
           
static int SHARE_CROSSTAB_QUERY
           
static int SHARE_QUERY
           
static int SHARE_TABLE_QUERY
           
 
Method Summary
 java.lang.Object checkData(java.lang.String checkType, java.lang.Object data)
          Check data for the invoker.
 boolean checkState(int state)
          Checks if the state in provide includes this.
 java.lang.String[] getAllStyleDisplayNames()
          Returns all available style display names.
 java.lang.String[] getAllStyles()
          Returns all available style names.
 java.lang.String getCurrentStyle()
          Returns the name of current used style.
 java.lang.Object[] getDataForColumns(java.lang.String[] sExpressions, int iMaxRecords, boolean byRow)
          Fetches data from dataset.
 org.eclipse.birt.chart.model.attribute.DataType getDataType(java.lang.String expression)
          Returns the data type according to the query expression.
 int getState()
          Returns state information of current data service provider.
 boolean isLivePreviewEnabled()
          Returns whether live preview is enabled
 org.eclipse.birt.chart.factory.IDataRowExpressionEvaluator prepareRowExpressionEvaluator(org.eclipse.birt.chart.model.Chart cm, java.util.List<java.lang.String> lExpressions, int iMaxRecords, boolean byRow)
          Prepare row expression evaluator for chart to bind data.
 void setStyle(java.lang.String styleName)
          Sets current used style by specified style name.
 boolean update(java.lang.String type, java.lang.Object value)
          Updates some custom data which is related with invoker.
 

Field Detail

HAS_DATA_SET

static final int HAS_DATA_SET
See Also:
Constant Field Values

HAS_CUBE

static final int HAS_CUBE
See Also:
Constant Field Values

DATA_BINDING_REFERENCE

static final int DATA_BINDING_REFERENCE
See Also:
Constant Field Values

IN_MULTI_VIEWS

static final int IN_MULTI_VIEWS
See Also:
Constant Field Values

SHARE_QUERY

static final int SHARE_QUERY
See Also:
Constant Field Values

PART_CHART

static final int PART_CHART
Indicates if current chart is a part of whole chart, such as plot or axis.

See Also:
Constant Field Values

MULTI_CUBE_DIMENSIONS

static final int MULTI_CUBE_DIMENSIONS
Indicates if current chart is using cube or sharing with crosstab or in multi-view, and cube's dimension count > 1.

See Also:
Constant Field Values

SHARE_TABLE_QUERY

static final int SHARE_TABLE_QUERY
See Also:
Constant Field Values

SHARE_CROSSTAB_QUERY

static final int SHARE_CROSSTAB_QUERY
See Also:
Constant Field Values

INHERIT_COLUMNS_ONLY

static final int INHERIT_COLUMNS_ONLY
See Also:
Constant Field Values

INHERIT_COLUMNS_GROUPS

static final int INHERIT_COLUMNS_GROUPS
See Also:
Constant Field Values

SHARE_CHART_QUERY

static final int SHARE_CHART_QUERY
See Also:
Constant Field Values
Method Detail

getAllStyles

java.lang.String[] getAllStyles()
Returns all available style names.


getAllStyleDisplayNames

java.lang.String[] getAllStyleDisplayNames()
Returns all available style display names. Note the count should be identical with getAllStyles().

Since:
2.1

getCurrentStyle

java.lang.String getCurrentStyle()
Returns the name of current used style.


setStyle

void setStyle(java.lang.String styleName)
Sets current used style by specified style name.


getDataForColumns

java.lang.Object[] getDataForColumns(java.lang.String[] sExpressions,
                                     int iMaxRecords,
                                     boolean byRow)
                                     throws org.eclipse.birt.chart.exception.ChartException
Fetches data from dataset.

Parameters:
sExpressions - column expression array in the form of javascript. Null will return all columns of dataset.
iMaxRecords - max row count. -1 returns default count or the preference value.
byRow - true: by row first, false: by column first
Returns:
Data array. if type is by row, array length is row length; if type is by column, array length is column length
Throws:
org.eclipse.birt.chart.exception.ChartException

isLivePreviewEnabled

boolean isLivePreviewEnabled()
Returns whether live preview is enabled

Returns:
whether live preview is enabled

getDataType

org.eclipse.birt.chart.model.attribute.DataType getDataType(java.lang.String expression)
Returns the data type according to the query expression.

Parameters:
expression -
Returns:
2.2

prepareRowExpressionEvaluator

org.eclipse.birt.chart.factory.IDataRowExpressionEvaluator prepareRowExpressionEvaluator(org.eclipse.birt.chart.model.Chart cm,
                                                                                         java.util.List<java.lang.String> lExpressions,
                                                                                         int iMaxRecords,
                                                                                         boolean byRow)
                                                                                         throws org.eclipse.birt.chart.exception.ChartException
Prepare row expression evaluator for chart to bind data.

Parameters:
cm -
lExpressions -
iMaxRecords -
byRow -
Throws:
org.eclipse.birt.chart.exception.ChartException
Since:
BIRT 2.3

update

boolean update(java.lang.String type,
               java.lang.Object value)
Updates some custom data which is related with invoker.

Parameters:
type -
value -
Since:
2.3
See Also:
ChartUIConstants.QUERY_CATEGORY, ChartUIConstants.QUERY_OPTIONAL, ChartUIConstants.QUERY_VALUE

getState

int getState()
Returns state information of current data service provider.

Returns:
state
Since:
2.3

checkState

boolean checkState(int state)
Checks if the state in provide includes this.

Parameters:
state -
Returns:
(getState() & state) == state
Since:
2.3

checkData

java.lang.Object checkData(java.lang.String checkType,
                           java.lang.Object data)
Check data for the invoker.

Parameters:
checkType -
data -
Since:
2.3


Copyright © 2005-2008 Actuate Corp. All rights reserved.