Eclipse BIRT Report Object Model (ROM)

JointDataSet Element

# Element Overview

Represents a data set joined by serveral data sets on respective join conditions.

### Details

Display Name: | Joint Data Set
Since: | 2.1
XML Element: | `joint-data-set`
Extends: | DataSet
Extendable: | Yes
Abstract: | No
Name Space: | Data Sets
Name Requirement: | Required
Allows User Properties: | Yes
Has Style: | No

### Property Summary

dataSets
joinConditions
  The join conditions on which the source data sets joined.
parameters
  Defines the data access attributes of the list of input and/or output parameters.
resultSet
  Defines the columns of the expected result set.

### Inherited Properties

cachedMetaData, columnHints, comments, computedColumns, customXml, displayName, displayNameID, eventHandlerClass, extends, filter, name, needsCache, propertyMasks, resultSetHints, rowFetchLimit, userProperties, viewAction

### Description

The name of the data sets by which this joint data set is joined. These data sets are defined by DataSet element.

### See Also

DataSet element in the ROM Styles Specification.

-->

# Property Detail

## dataSets Property

### Details

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

## joinConditions Property

The join conditions on which the source data sets joined.

### Details

Type: | List of JoinCondition Structures
Since: | 2.1
Required: | No
Display Name: | Join conditions
JavaScript Type: |
Default Value: | None
Inherited: | Yes
Runtime Settable: | Yes
Property Sheet Visibility: | Hidden
Property Sheet Group: | Top

### Description

The join conditions on which the source data sets joined. Each join condition specify two data sets, which join on this condition, and the type of this join. The left expression, right expression and operator constitute the condition.

## parameters Property

Defines the data access attributes of the list of input and/or output parameters.

### Details

Type: | List of DataSetParam Structures
Since: | 1.0
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

### Description

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.

### See Also

`DataSetParam structure`

`ParamBinding structure`

## resultSet Property

Defines the columns of the expected result set.

### Details

Type: | List of ResultSetColumn 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

### Description

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.

### See Also

`ResultSetColumn structure`