Eclipse BIRT Report Object Model (ROM)

Measure Element

Element Overview

Base element for measure elements within a cube.

Details

Display Name: Measure
Since: 2.2
XML Element: None
Extends: ReportElement
Extendable: No
Abstract: Yes
Name Space: None
Name Requirement: Required
Allows User Properties: Yes
Has Style: No

Property Summary

dataType
Measure data type property.
function
The aggregation function applied to this measure.
isCalculated
Indicate whether this measure is computed by other measures.
measureExpression
The BIRT expression that defines the value of the measure element.

Inherited Properties

comments, customXml, displayName, displayNameID, eventHandlerClass, extends, name, newHandlerOnEachEvent, propertyMasks, userProperties, viewAction

Description

The measure is an abstract element that defines the basic properties of a measure element. It has two derived elements: tabular and ODA measure elements.

Measure is the quantity that you are interested in measuring, for example, unit sales of a product, or cost price of inventory items.

Property Detail

dataType Property

Measure data type property.

Details

Type: choice (columnDataType)
Since: 2.2
Required: No
Display Name: Data type
JavaScript Type:
Default Value: decimal
Inherited: Yes
Runtime Settable: No
Property Sheet Visibility: Visible
Property Sheet Group: Top

Choices

NameDisplay Name ValueDescription
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
blob Blob blob
javaObject Java Object javaObject

Description

This property gives out the data type of the measure resulting data.


function Property

The aggregation function applied to this measure.

Details

Type: choice (aggregationFunction)
Since: 2.2
Required: No
Display Name: Function
JavaScript Type:
Default Value: sum
Inherited: Yes
Runtime Settable: No
Property Sheet Visibility: Visible
Property Sheet Group: Top

Choices

NameDisplay Name ValueDescription
sum SUM sum
count COUNT count
min MIN min
max MAX max
average AVERAGE average
weighted-avg WEIGHTEDAVG weighted-avg
stddev STDDEV stddev
first FIRST first
last LAST last
mode MODE mode
moving-ave MOVINGAVE moving-ave
median MEDIAN median
variance VARIANCE variance
running-sum RUNNINGSUM running-sum
irr IRR irr
mirr MIRR mirr
npv NPV npv
running-npv RUNNINGNPV running-npv
count-distinct COUNTDISTINCT count-distinct
running-count RUNNINGCOUNT running-count
is-top-n IS-TOP-N is-top-n
is-bottom-n IS-BOTTOM-N is-bottom-n
is-top-n-percent IS-TOP-N-PERCENT is-top-n-percent
is-bottom-n-percent IS-BOTTOM-N-PERCENT is-bottom-n-percent
percent-rank PERCENT-RANK percent-rank
percentile PERCENTILE percentile
quartile QUARTILE quartile
percent-sum PERCENT-SUM percent-sum
rank RANK rank

Description

This property gives out the function that user wants to apply on this measure.


isCalculated Property

Indicate whether this measure is computed by other measures.

Details

Type: boolean
Since: 2.2
Required: No
Display Name: Is calculated
JavaScript Type:
Default Value: false
Inherited: Yes
Runtime Settable: No
Property Sheet Visibility: Visible
Property Sheet Group: Top

Description

This property indicates whether this measure is computed by other measures. True if it is calculated by other measures; otherwise false. By default, its value is FALSE.


measureExpression Property

The BIRT expression that defines the value of the measure element.

Details

Type: expression
Context:
Expression Type: None
Since: 2.2
Required: No
Display Name: Measure expression
JavaScript Type:
Default Value: None
Inherited: Yes
Runtime Settable: No
Property Sheet Visibility: Visible
Property Sheet Group: Top

Description

The expression that gets evaluated and its resulting value assigned to the measure element. If the isCalculated is false, then the value of this property should be a column name. If it is true, the value of this property should be an expression for the computed measure.