Eclipse BIRT Report Object Model (ROM)
ScriptDataSet Element
Display Name: | Script Data Set |
Since: | 1.0 |
XML Element: | script-data-set |
Extends: | SimpleDataSet |
Extendable: | Yes |
Abstract: | No |
Name Space: | Data Sets |
Name Requirement: | Required |
Allows User Properties: | Yes |
Has Style: | No |
cachedMetaData, columnHints, comments, computedColumns, customXml, dataSetRowLimit, displayName, displayNameID, eventHandlerClass, extends, filter, name, needsCache, newHandlerOnEachEvent, paramBindings, parameters, propertyMasks, refTemplateParameter, resultSetHints, rowFetchLimit, sortHints, userProperties, viewAction
beforeOpen, beforeClose, onFetch, afterOpen, afterClose
Represents a data set defined in JavaScript code, providing methods for opening, fetching and closing the data set. It defines the overall properties of the scripted data set including the JavaScript methods themselves and an optional result set definition.
The database connection that the data set is used.
Type: | DataSource Reference |
Since: | 1.0 |
Required: | Yes |
Display Name: | Data source |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
Name of the data source, that is the database connection this data set is using.
DataSetParam structure
ParamBinding structure
Called by BIRT to close the data set.
None obj.close( )
Since: | 1.0 |
Context: | factory |
Arguments: | None |
Return Type: | None |
Closes the data set. Optional.
beforeClose
method
afterClose
method
Dynamically describes the result set definition in JavaScript.
ColumnDefn[] obj.describe( )
Since: | reserved |
Context: | factory |
Arguments: | None |
Return Type: | ColumnDefn[] |
The Describe method can return null, which tells BIRT to use the static definition instead. The script can access the static description using the design object within the script.
If the method returns a column array, then the array must satisfy the following constraints:
Called before BIRT calls the
beforeOpen
method. Creates a
runt-time definition of the result set columns. Returns an array of
ResultSetColumn objects. Each object describes a column in the expected result
set. Optional.
ResultSetColumn
structure
Fetches a row from the data set.
DataRow obj.fetch( )
Since: | 1.0 |
Context: | factory |
Arguments: | None |
Return Type: | DataRow |
Returns true
if there is another row to fetch, false
if there are no more
rows. When the data set has returned the last row from the result set,
subsequent calls to
fetch
should return false
.
Fetches a row from the data set on each call, and populates the current row
available in the row
property.
onFetch
method
DataRow scripting object
Opens the data set.
None obj.open( )
Since: | 1.0 |
Context: | factory |
Arguments: | None |
Return Type: | None |
Opens the external data set. Throws a JavaScript exception if the open fails. Often refers to report parameters or user-defined parameters for information about the data set. Optional.
beforeOpen
method
afterOpen
method