Eclipse BIRT Report Object Model (ROM)

ComputedColumn Structure

Structure Overview

A user-defined column in the result set.

Details

Display Name: Computed Column
Since: 1.0

Property Summary

aggregateFunction
aggregateOn
arguments
dataType
Column data type property.
displayName
expression
The BIRT expression that defines the value of the computed column.
filterExpr
name
The name of the computed column.

Description

A computed column is a user-defined column produced as an expression of other columns within the data set. It is not one of the columns retrieved directly from the underlying data provider.

Property Detail

aggregateFunction Property

Details

Type: string
Since: 2.2
Required: No
Display Name: AggregateOn Function
JavaScript Type:
Default Value: None
Runtime Settable: Yes

aggregateOn Property

Details

Type: list
Since: 2.2
Required: No
Display Name: AggregateOn Expression
JavaScript Type:
Default Value: None
Runtime Settable: Yes

arguments Property

Details

Type: List of AggregationArgument Structures
Since: 2.2
Required: No
Display Name: AggregateOn Function Arguments
JavaScript Type:
Default Value: None
Runtime Settable: Yes

dataType Property

Column data type property.

Details

Type: choice (columnDataType)
Since: 2.0
Required: No
Display Name: Data Type
JavaScript Type:
Default Value: any
Runtime Settable: No

Choices

NameDisplay Name ValueDescription
any Any any
integer Integer integer
string String string
date-time Date Time date-time
decimal Decimal decimal
float Float float
boolean Boolean boolean
date Date date
time Time time

Description

Column data type property.


displayName Property

Details

Type: string
Since: 2.2
Required: No
Display Name: Column Display Name
JavaScript Type:
Default Value: None
Runtime Settable: No

expression Property

The BIRT expression that defines the value of the computed column.

Details

Type: expression
Context: factory
Expression Type: any
Since: 1.0
Required: No
Display Name: Expression
JavaScript Type:
Default Value: None
Runtime Settable: No

Description

The expression that gets evaluated and its resulting value assigned to the computed column.


filterExpr Property

Details

Type: expression
Context:
Expression Type: None
Since: 2.2
Required: No
Display Name: Filter Expression
JavaScript Type:
Default Value: None
Runtime Settable: Yes

name Property

The name of the computed column.

Details

Type: memberKey
Since: 1.0
Required: Yes
Display Name: Column Name
JavaScript Type:
Default Value: None
Runtime Settable: No

Description

The name of the computed column and is required. The name must be unique within the result set.

See Also

The Result Column Names section for the naming rules.