Eclipse BIRT Report Object Model (ROM)

ResultSetColumn Structure

Structure Overview

Describes a column within a result set.

Details

Display Name: Column
Since: 1.0

Property Summary

dataType
The optional data type of the column.
name
The name of the column.
nativeDataType
position
The 1-based position of the column, as defined by the driver of underlying data provider.

Description

The column definition element describes a column within a result set.

Property Detail

dataType Property

The optional data type of the column.

Details

Type: choice (columnDataType)
Since: 1.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 A whole number.
string String string Arbitrary Unicode text.
date-time Date Time date-time A date, time or combination of date and time.
decimal Decimal decimal Any type of number including currency. Fixed decimal, arbitrary precision.
float Float float A scientific amount using the usual floating point notation.
boolean Boolean boolean
date Date date
time Time time

Description

The optional data type. Required only for data sets that require this information.


name Property

The name of the column.

Details

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

Description

The name of a result set column. Required. This is the column name referenced by report elements.

See Also

The Result Set Columns´┐Ż Column Names section above for the naming rules.


nativeDataType Property

Details

Type: integer
Since: 2.1
Required: No
Display Name: Native data type code
JavaScript Type:
Default Value: None
Runtime Settable: No

position Property

The 1-based position of the column, as defined by the driver of underlying data provider.

Details

Type: integer
Since: 1.0
Required: No
Display Name: Position
JavaScript Type:
Default Value: None
Runtime Settable: No

Description

The optional 1-based position of the column, as defined by the driver of underlying data provider. Required for data sets that identify columns by position instead of name; ignored otherwise.