Eclipse BIRT Report Object Model (ROM)

JoinCondition Structure

Structure Overview

Defines a join condition.

Details

Display Name: Join Condition
Since: 2.1

Property Summary

joinOperator
The comparator of the condition.
joinType
The join type.
leftDataSet
The name of left data set of the condition.
leftExpression
The left expression of the condition.
rightDataSet
The name of right data set of the condition.
rightExpression
The right expression of the condition.

Description

User can define a joint data set which is a data set joined by several data sets on some join conditions, The join condition is whether two expressions,left expression and right expression, satisfy a relationship defined by the join operator which can be equality, less than or greater than. Left expression is an expression of fields from left dataset, right expression is an expression of fields from right dataset.

For example, a condition can be:

       dataSet1 inner join dataSet2 on 2 * column1 = 3 * column2

"column1" is from the data set named "dataSet1", "coloumn2" is from "dataSet2".

This condition is defined by JoinCondition with following members:

joinType=inner join
joinOperator=eq
leftDataSet="dataSet1"
rightDataSet="dataSet2"
leftExpression="2 * column1"
rightExpression="3 * column2"

Property Detail

joinOperator Property

The comparator of the condition.

Details

Type: choice (joinOperator)
Since: 2.1
Required: No
Display Name: Join operator
JavaScript Type:
Default Value: eq
Runtime Settable: Yes

Choices

NameDisplay Name ValueDescription
eq Equals eq

Description

The comparator of the condition: equals, less than or greater than.


joinType Property

The join type.

Details

Type: choice (joinType)
Since: 2.1
Required: No
Display Name: Join type
JavaScript Type:
Default Value: inner
Runtime Settable: Yes

Choices

NameDisplay Name ValueDescription
inner Inner Join inner
left-out Left Out Join left-out
right-out Right Out Join right-out
full-out Full Out Join full-out

Description

The join type: inner join, left out join or right out join.


leftDataSet Property

The name of left data set of the condition.

Details

Type: string
Since: 2.1
Required: Yes
Display Name: Left data set
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

The name of left data set of the condition.


leftExpression Property

The left expression of the condition.

Details

Type: expression
Context:
Expression Type: any
Since: 2.1
Required: Yes
Display Name: Left expression
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

The left expression of the condition.


rightDataSet Property

The name of right data set of the condition.

Details

Type: string
Since: 2.1
Required: Yes
Display Name: Right data set
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

The name of right data set of the condition.


rightExpression Property

The right expression of the condition.

Details

Type: expression
Context:
Expression Type: any
Since: 2.1
Required: Yes
Display Name: Right expression
JavaScript Type:
Default Value: None
Runtime Settable: Yes

Description

The right expression of the condition.