|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IBaseDataSetDesign
Describes the static design of any data set to be used by the Data Engine. Each sub-interface defines a specific type of data set.
Method Summary | |
---|---|
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 |
setRowFetchLimit(int max)
Set up the max number of rows that the data set represent by this IBaseDataSetDesign instance can fetch from data source. |
Method Detail |
---|
java.lang.String getName()
int getCacheRowCount()
boolean needDistinctValue()
java.lang.String getDataSourceName()
java.util.List getComputedColumns()
java.util.List getFilters()
IFilterDefinition
objects. The data set should discard any
row that does not satisfy all the filters.
java.util.List getParameters()
IParameterDefinition
objects.
java.util.List getResultSetHints()
IColumnDefinition
objects.
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.java.util.Collection getInputParamBindings()
IInputParameterBinding
objects.
java.lang.String getBeforeOpenScript()
beforeOpen
script to be called just before opening the data
set.
beforeOpen
script. Null if none is defined.java.lang.String getAfterOpenScript()
afterOpen
script to be called just after the data set is
opened, but before fetching each row.
afterOpen
script. Null if none is defined.java.lang.String getOnFetchScript()
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.)
onFetch
script. Null if none is defined.java.lang.String getBeforeCloseScript()
beforeClose
script to be called just before closing the
data set.
beforeClose
script. Null if none is defined.java.lang.String getAfterCloseScript()
afterClose
script to be called just after the data set is
closed.
afterClose
script. Null if none is defined.IBaseDataSetEventHandler getEventHandler()
void setRowFetchLimit(int max)
max
- int getRowFetchLimit()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |