Eclipse BIRT Report Object Model (ROM)

ScriptDataSet Element

Element Overview

A data set defined in JavaScript.

Details

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

Property Summary

dataSource

Method Summary

close
describe
fetch
open

Inherited Properties

cachedMetaData, columnHints, comments, computedColumns, customXml, dataSetRowLimit, displayName, displayNameID, eventHandlerClass, extends, filter, name, needsCache, newHandlerOnEachEvent, paramBindings, parameters, propertyMasks, refTemplateParameter, resultSetHints, rowFetchLimit, userProperties, viewAction

Inherited Methods

beforeOpen, beforeClose, onFetch, afterOpen, afterClose

Description

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.

See Also

Script Data Source element

DataSet scripting object

Property Detail

dataSource Property

Details

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

Method Detail

close Method

Synopsis

None obj.close( )

Details

Since: 1.0
Context: factory
Arguments: None
Return Type: None

describe Method

Synopsis

ColumnDefn[] obj.describe( )

Details

Since: reserved
Context: factory
Arguments: None
Return Type: ColumnDefn[]

fetch Method

Synopsis

DataRow obj.fetch( )

Details

Since: 1.0
Context: factory
Arguments: None
Return Type: DataRow

open Method

Synopsis

None obj.open( )

Details

Since: 1.0
Context: factory
Arguments: None
Return Type: None