Eclipse BIRT Report Object Model (ROM)

MapRule Structure

# Structure Overview

Represents a map rule; each map rule consists of a test expression, operator, values and corresponding translated value

### Details

Display Name: | MapRule
Since: | 1.0

### Property Summary

display
  The value to display when the map rule "triggers."
displayID
  Resource key for the display value.
isDesignTime
operator
  The operator for a simple condition
testExpr
  An expression used to map internal values to display values
value1
  The value for simple conditions with the operators: <, <=, =, <>, >=, >, between, not between, like
value2
  The value for simple conditions with the operators: between, not between

### Description

A map rule is part of the map rules. Each map rule contains a condition that matches the value, and a value to display when the rule "triggers." For example, a set of map rules for a "gender" database column may map the values null, M, F into the display values "No data", "Male" and "Female".

# Property Detail

## display Property

The value to display when the map rule "triggers."

### Details

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

### Description

The display value appears when the map rule triggers. The value is a string and is not further formatted

### See Also

## displayID Property

Resource key for the display value.

### Details

Type: | resourceKey
Since: | 1.0
Required: | No
Display Name: | DisplayID
JavaScript Type: |
Default Value: | None
Runtime Settable: | Yes

### See Also

## isDesignTime Property

### Details

Type: | boolean
Since: | 2.2
Required: | No
Display Name: | Is Design Time
JavaScript Type: |
Default Value: | true
Runtime Settable: | Yes

## operator Property

The operator for a simple condition

### Details

Type: | choice (mapOperator)
Since: | 1.0
Required: | No
Display Name: | Operator
JavaScript Type: |
Default Value: | eq
Runtime Settable: | Yes

### Choices

Name | Display Name | Value | Description
eq | Equal to | eq |
ne | Not Equal to | ne |
lt | Less than | lt |
le | Less than or Equal | le |
ge | Greater than or Equal | ge |
gt | Greater than | gt |
between | Between | between |
not-between | Not Between | not-between |
is-null | Is Null | is-null |
is-not-null | Is Not Null | is-not-null |
is-true | Is True | is-true |
is-false | Is False | is-false |
like | Like | like |
match | Match | match |
top-n | Top n | top-n |
bottom-n | Bottom n | bottom-n |
top-percent | Top percent | top-percent |
bottom-percent | Bottom percent | bottom-percent |
not-like | Not Like | not-like |
not-match | Not Match | not-match |

### See Also

## testExpr Property

An expression used to map internal values to display values

### Details

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

### See Also

## value1 Property

The value for simple conditions with the operators: <, <=, =, <>, >=, >, between, not between, like

### Details

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

### See Also

## value2 Property

The value for simple conditions with the operators: between, not between

### Details

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

### See Also