|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.data.engine.api.querydefn.BaseDataSetDesign
public class BaseDataSetDesign
Default implementation of IBaseDataSetDesign
interface.
Describes the static design of a data set to be used by the Data Engine. Each subclass defines a specific type of data set.
Constructor Summary | |
---|---|
BaseDataSetDesign(java.lang.String name)
Instantiates a data set with given name. |
|
BaseDataSetDesign(java.lang.String name,
java.lang.String dataSourceName)
Instantiates a data set with given name and data source name. |
Method Summary | |
---|---|
void |
addComputedColumn(IComputedColumn column)
Adds a new computed column to the data set. |
void |
addFilter(IFilterDefinition filter)
Adds a filter to the filter list. |
void |
addInputParamBinding(IInputParameterBinding binding)
Adds an input parameter binding. |
void |
addParameter(IParameterDefinition param)
Adds a parameter definition to the data set. |
void |
addResultSetHint(IColumnDefinition col)
Adds a column to the result set hints definition. |
java.lang.String |
getAfterCloseScript()
Returns the afterClose script to be called just after the data set is
closed. |
java.lang.String |
getAfterOpenScript()
Returns the afterOpen script to be called just after the data set is
opened, but before fetching each row. |
java.lang.String |
getBeforeCloseScript()
Returns the beforeClose script to be called just before closing the
data set. |
java.lang.String |
getBeforeOpenScript()
Returns the beforeOpen script to be called just before opening the data
set. |
int |
getCacheRowCount()
Deprecated. |
java.util.List |
getComputedColumns()
Returns a list of computed columns. |
java.lang.String |
getDataSourceName()
Returns the data source (connection) name for this data set. |
IBaseDataSetEventHandler |
getEventHandler()
Returns the event handler for the data set |
java.util.List |
getFilters()
Returns a list of filters. |
java.util.Collection |
getInputParamBindings()
Returns the set of input parameter bindings as an unordered collection of IInputParameterBinding objects. |
java.lang.String |
getName()
Gets the name of the data set. |
java.lang.String |
getOnFetchScript()
Returns the onFetch script to be called just after the a row is read
from the data set. |
java.util.List |
getParameters()
Returns the data set parameter definitions as a list of IParameterDefinition objects. |
java.util.List |
getResultSetHints()
Returns the primary result set hints as a list of IColumnDefinition
objects. |
int |
getRowFetchLimit()
Return the max number of rows that the data set represent by this IBaseDataSetDesign intance can fetch from data source. |
boolean |
needDistinctValue()
When user wants to retrieve the distinct row, this flag needs to be set as true. |
void |
setAfterCloseScript(java.lang.String afterCloseScript)
Sets the afterClose script for the data set |
void |
setAfterOpenScript(java.lang.String afterOpenScript)
Sets the afterOpen script for the data set |
void |
setBeforeCloseScript(java.lang.String beforeCloseScript)
Sets the beforeClose script for the data set |
void |
setBeforeOpenScript(java.lang.String beforeOpenScript)
Sets the beforeOpen script for the data set |
void |
setCacheRowCount(int cacheRowCount)
Deprecated. |
void |
setDataSource(java.lang.String dataSourceName)
Specifies the data source (connection) name. |
void |
setDistinctValue(boolean distinctValue)
|
void |
setEventHandler(IBaseDataSetEventHandler handler)
Sets the event handler for this data set |
void |
setOnFetchScript(java.lang.String onFetchScript)
Sets the onFetch script for the data set |
void |
setRowFetchLimit(int max)
Set up the max number of rows that the data set represent by this IBaseDataSetDesign instance can fetch from data source. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BaseDataSetDesign(java.lang.String name)
name
- Name of data setpublic BaseDataSetDesign(java.lang.String name, java.lang.String dataSourceName)
name
- Name of data setdataSourceName
- Name of data source used by this data set.
Can be null or empty if this data
set does not specify a data source.Method Detail |
---|
public java.lang.String getName()
IBaseDataSetDesign
getName
in interface IBaseDataSetDesign
IBaseDataSetDesign.getName()
public int getCacheRowCount()
IBaseDataSetDesign
getCacheRowCount
in interface IBaseDataSetDesign
public void setCacheRowCount(int cacheRowCount)
cacheRowCount
- public boolean needDistinctValue()
IBaseDataSetDesign
needDistinctValue
in interface IBaseDataSetDesign
public void setDistinctValue(boolean distinctValue)
distinctValue
- public java.lang.String getDataSourceName()
IBaseDataSetDesign
getDataSourceName
in interface IBaseDataSetDesign
IBaseDataSetDesign.getDataSourceName()
public void setDataSource(java.lang.String dataSourceName)
dataSourceName
- The name of the dataSource to set.public java.util.List getComputedColumns()
IBaseDataSetDesign
getComputedColumns
in interface IBaseDataSetDesign
IBaseDataSetDesign.getComputedColumns()()
public void addComputedColumn(IComputedColumn column)
column
- Could be null.public java.util.List getFilters()
IBaseDataSetDesign
IFilterDefinition
objects. The data set should discard any
row that does not satisfy all the filters.
getFilters
in interface IBaseDataSetDesign
IBaseDataSetDesign.getFilters()
public void addFilter(IFilterDefinition filter)
filter
- Could be null.public java.util.List getParameters()
IBaseDataSetDesign
IParameterDefinition
objects.
getParameters
in interface IBaseDataSetDesign
IBaseDataSetDesign.getParameters()
public void addParameter(IParameterDefinition param)
public java.util.List getResultSetHints()
IBaseDataSetDesign
IColumnDefinition
objects.
getResultSetHints
in interface IBaseDataSetDesign
IColumnDefinition
objects.
An empty list if none is defined, which normally
means that the data set can provide the definition
from the underlying data access provider.IBaseDataSetDesign.getResultSetHints()
public void addResultSetHint(IColumnDefinition col)
public java.util.Collection getInputParamBindings()
IBaseDataSetDesign
IInputParameterBinding
objects.
getInputParamBindings
in interface IBaseDataSetDesign
IBaseDataSetDesign.getInputParamBindings()
public void addInputParamBinding(IInputParameterBinding binding)
binding
- Could be null.public java.lang.String getBeforeOpenScript()
IBaseDataSetDesign
beforeOpen
script to be called just before opening the data
set.
getBeforeOpenScript
in interface IBaseDataSetDesign
beforeOpen
script. Null if none is defined.IBaseDataSetDesign.getBeforeOpenScript()
public void setBeforeOpenScript(java.lang.String beforeOpenScript)
beforeOpen
script for the data set
public java.lang.String getAfterOpenScript()
IBaseDataSetDesign
afterOpen
script to be called just after the data set is
opened, but before fetching each row.
getAfterOpenScript
in interface IBaseDataSetDesign
afterOpen
script. Null if none is defined.IBaseDataSetDesign.getAfterOpenScript()
public void setAfterOpenScript(java.lang.String afterOpenScript)
afterOpen
script for the data set
afterOpenScript
- The AfterOpen script to set.public java.lang.String getOnFetchScript()
IBaseDataSetDesign
onFetch
script to be called just after the a row is read
from the data set. Called after setting computed columns and only for
rows that pass the filters. (Not called for rows that are filtered out
of the data set.)
getOnFetchScript
in interface IBaseDataSetDesign
onFetch
script. Null if none is defined.IBaseDataSetDesign.getOnFetchScript()
public void setOnFetchScript(java.lang.String onFetchScript)
onFetch
script for the data set
public java.lang.String getBeforeCloseScript()
IBaseDataSetDesign
beforeClose
script to be called just before closing the
data set.
getBeforeCloseScript
in interface IBaseDataSetDesign
beforeClose
script. Null if none is defined.IBaseDataSetDesign.getBeforeCloseScript()
public void setBeforeCloseScript(java.lang.String beforeCloseScript)
beforeClose
script for the data set
public java.lang.String getAfterCloseScript()
IBaseDataSetDesign
afterClose
script to be called just after the data set is
closed.
getAfterCloseScript
in interface IBaseDataSetDesign
afterClose
script. Null if none is defined.IBaseDataSetDesign.getAfterCloseScript()
public void setAfterCloseScript(java.lang.String afterCloseScript)
afterClose
script for the data set
public IBaseDataSetEventHandler getEventHandler()
IBaseDataSetDesign
getEventHandler
in interface IBaseDataSetDesign
IBaseDataSetDesign.getEventHandler()
public void setEventHandler(IBaseDataSetEventHandler handler)
public int getRowFetchLimit()
IBaseDataSetDesign
getRowFetchLimit
in interface IBaseDataSetDesign
public void setRowFetchLimit(int max)
IBaseDataSetDesign
setRowFetchLimit
in interface IBaseDataSetDesign
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |