![]() ![]() |
The ODA Data Set represents an extended data set that implements the BIRT Open Data Access (ODA) interfaces. The ODA interface defines a rich set of metadata 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 metadata 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 definitions and hints. Data-access attributes, such as name and type, are typical derived attributes. They are defined in the Result Set definition and are used only if the run-time driver cannot provide such metadata.
An ODA driver statically defines driver-specific data set query properties by implementing the ODA model extension point.
DesignElement->ReportElement->DataSet
cachedMetaData, columnHints, comments, computedColumns, customXml, dataSource, extends, filter, name, paramBindings, parameters, resultSet, userProperties
None
afterOpen, afterClose, beforeOpen, beforeClose, onFetch
None
The following sections describe the properties of the ODADataSet element.
The fully-qualified ID that uniquely identifies a type of ODA data set definition in the BIRT environment. Extension IDs are defined in the ODA data source extension plug-in manifest, plugin.xml, in the dataSet.id attribute. The value of the extension ID is optional if the ODA extension supports only one type of data set.
A list of dynamic name-value 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. BIRT stores these name-value pairs in the report design file as a persistent service and passes them to the ODA run-time driver during the generation phase.
The query text used in opening a data set. Specific ODA driver defines the format of this string. BIRT passes the query text to the ODA run-time driver to prepare a statement for execution.
![]() ![]() |