Eclipse BIRT Report Object Model (ROM)

DerivedDataSet Element

# Element Overview

An extended data set retrieved by a query through an extension driver and contains sub data set contents.

### Details

Display Name: | Derived Data Set
Since: | 2.5
XML Element: | `derived-data-set`
Extends: | SimpleDataSet
Extendable: | Yes
Abstract: | No
Name Space: | Data Sets
Name Requirement: | Required
Allows User Properties: | Yes
Has Style: | No

### Property Summary

extensionID
  The ID of a data set type supported by the ODA data source extension.
inputDataSets
  The sub data set elements that the query text refer.
queryText
  The static query text to execute.

### Inherited Properties

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

### Inherited Methods

beforeOpen, beforeClose, onFetch, afterOpen, afterClose

### Description

The Derived Data Set represents an extended data set that defines query text which is managed by an extension driver.

The Derived Data Set element defines a series of sub data set elements that are referred in their query text. The item in the list can be any type of data set Model supports, such as script data set, ODA data set, joint data set and another derived data set.

# Property Detail

## extensionID Property

The ID of a data set type supported by the ODA data source extension.

### Details

Type: | string
Since: | 2.5
Required: | No
Display Name: | Extension ID
JavaScript Type: |
Default Value: | None
Inherited: | Yes
Runtime Settable: | Yes
Property Sheet Visibility: | Hidden
Property Sheet Group: | Top

### Description

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.

## inputDataSets Property

The sub data set elements that the query text refer.

### Details

Type: | list
Since: | 2.5
Required: | No
Display Name: | Input data sets
JavaScript Type: |
Default Value: | None
Inherited: | Yes
Runtime Settable: | Yes
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### Description

List of the name of the sub data sets that this element refers.

## queryText Property

The static query text to execute.

### Details

Type: | xml
Since: | 2.5
Required: | No
Display Name: | Query
JavaScript Type: |
Default Value: | None
Inherited: | Yes
Runtime Settable: | Yes
Property Sheet Visibility: | Visible
Property Sheet Group: | Top

### Description

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.