Eclipse BIRT Report Object Model (ROM)
OdaDataSet Element
Display Name: | ODA Data Set |
Since: | 1.0 |
XML Element: | oda-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, dataSource, displayName, displayNameID, eventHandlerClass, extends, filter, name, needsCache, paramBindings, propertyMasks, refTemplateParameter, resultSetHints, rowFetchLimit, userProperties, viewAction
beforeOpen, beforeClose, onFetch, afterOpen, afterClose
The ODA Data Set represents an extended data set that implements the Open Data Access (ODA) interfaces. The ODA interface defines a rich set of meta-data attributes available to the BIRT Designer to help the user build the report. The ODA Data Set definition contains the minimum amount of information necessary to access the desired data source. The rest of the available meta-data information is obtained from the ODA driver when needed.
The ODA Data Set element defines a single ODA data set of a specific type. An ODA Data Source may support one or more types of ODA data sets.
Both the data set element and the ODA driver can provide column definition
and hints. Data-access attributes, such as name and type, are typical derived
attributes. They are defined in the inherited resultSet
definition, and are
used only if the run-time driver cannot provide such meta-data.
An ODA driver may statically define driver-specific data set query
properties by defining the property
element in the ODA data
source extension point (org.eclipse.birt.data.oda.dataSource).
See the BIRT Extensions functional
specification document for more detail description. By implementing the
extension point, an ODA driver's extension plug-in manifest (plugin.xml) could define
static driver-specific data set query properties. BIRT uniquely identifies each
extension-defined property within the scope of its ODA extension. BIRT supports
these properties as extended
ROM properties with all their built-in features, such as direct editing from
the BIRT designer's property sheet. For ease of segregating these
driver-specific properties in the property sheet, one could define them within
a propertyGroup
element with a group display name like "Query Properties". Such grouping is purely for display in a
property sheet. Each property in a
display group is treated as a top-level property, whose grouping is not visible,
when it is accessed programmatically. At Factory time, these static extension-defined properties are passed in
name-value pairs to the ODA driver as a query's run-time properties.
See the Description of the ODA Data Source element for an example of the ODA data source extension plug-in manifest.
OdaDataSource element
DataSet element
DataSet
scripting object
Type: | OdaDesignerState Structure |
Since: | 2.1 |
Required: | No |
Display Name: | Designer state |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
Type: | xml |
Since: | 2.1.1 |
Required: | No |
Display Name: | Designer values |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
The ID of a data set type supported by the ODA data source extension.
Type: | string |
Since: | 1.0 |
Required: | No |
Display Name: | Extension ID |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
The fully qualified ID that uniquely identifies the type
of ODA data set definition in the BIRT environment. It is defined in the ODA data
source extension plug-in manifest (plugin.xml) in the dataSet.id
attribute. Its value is optional
if the ODA extension supports only one type of data set.
Defines the data access attributes of the list of input and/or output parameters.
Type: | List of OdaDataSetParam Structures |
Since: | 2.1.1 |
Required: | No |
Display Name: | Data set parameters |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
Many data sets allow parameters, which can be of input and/or output modes. For some, the user must define the parameters as part of the data set definition. For other data sets, the driver itself can provide the set of parameter definitions from the information available in a data set query. In the latter case, parameter definitions are derived data and are not stored in the parameter definition.
Some drivers refer to a parameter by position. Others can refer to a parameter by name. Also, for some data sets, the data set definition can omit parameter definitions for optional parameters not used within the report. Not all parameter properties are required. If a property is omitted. BIRT assumes that the data set implementation can provide it at run time. If the driver cannot provide the information, then a runtime error occurs. This is an optional list of data set parameter definitions, used only when the underlying data provider cannot provide this information. When contradicting meta-data are found between those provided dynamically by a data provider and those specified in a data set definition, the data provider�s meta-data takes precedence.
DataSetParam structure
ParamBinding structure
A dynamic list of name-value structures that specify private data or attributes specific to the ODA data set query.
Type: | List of ExtendedProperty Structures |
Since: | 1.0 |
Required: | No |
Display Name: | Private driver properties |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
A dynamic list of name-value structures (ExtendedProperty
structures) that
specify private run-time data or attributes specific to the ODA data set. This
is an optional element that an ODA driver may use to store and pass pertinent
driver-specific attributes from its designer tool to the run-time driver. The
content of this element is specific and private to an ODA driver, whose
designer tool can dynamically define and update them as appropriate. These
name-value pairs are stored in the report design file as a persistent service,
and are passed to the ODA driver at Factory time as a query's run-time
properties.
ExtendedProperty
structure
The static query text to execute.
Type: | literalString |
Since: | 1.0 |
Required: | No |
Display Name: | Query |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |
The query text used in opening a data set. Specific ODA driver defines the format of this string. The query text is passed through to the ODA run-time driver to prepare a query for execution.
Defines the columns of the expected result set.
Type: | List of OdaResultSetColumn Structures |
Since: | 1.0 |
Required: | No |
Display Name: | Result set columns |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
Defines the data access attributes of the list of columns in the expected primary result set. This is an optional list of result set column definitions, used only when the underlying data provider cannot provide this information. When contradicting meta-data are found between those provided dynamically by a data provider and those specified in a data set definition, the data provider�s meta-data takes precedence.
ResultSetColumn structure
Identifies which result set to access if a query returns multiple result sets.
Type: | string |
Since: | reserved |
Required: | No |
Display Name: | Result set name |
JavaScript Type: | |
Default Value: | None |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Hidden |
Property Sheet Group: | Top |
Some ODA drivers provide multiple named result sets from a single query. In
the first release, BIRT can access only one of these result sets. This property
identifies which named result set to access. The inherited resultSet
definition, if specified, is for this result set.
Required if multiple result sets are available, and a result set must be accessed by name. This property is not applicable when multiple result sets are returned in sequence; the first result set is treated as the primary result set.
Type: | integer |
Since: | 2.3 |
Required: | No |
Display Name: | Result set number |
JavaScript Type: | |
Default Value: | 1 |
Inherited: | Yes |
Runtime Settable: | Yes |
Property Sheet Visibility: | Visible |
Property Sheet Group: | Top |