org.eclipse.birt.report.model.api.elements.structures
Class MapRule

java.lang.Object
  extended by org.eclipse.birt.report.model.core.Structure
      extended by org.eclipse.birt.report.model.core.PropertyStructure
          extended by org.eclipse.birt.report.model.api.elements.structures.StyleRule
              extended by org.eclipse.birt.report.model.api.elements.structures.MapRule
All Implemented Interfaces:
java.lang.Cloneable, IStructure, org.eclipse.birt.report.model.core.IPropertySet

public class MapRule
extends StyleRule

This class represents a style mapping rule: a translation of a database value into a set of display values. A map might translate DB status codes (O, S, P) into user-visible strings (Open, Shipped, Paid). The mapping is driven of of a mapping test expression defined on the style. This class extends the StyleRule class, see that class for additional details.


Field Summary
protected  java.lang.String display
          The non-localized text to display when the rule "fires.".
static java.lang.String DISPLAY_ID_MEMBER
          Name of the member variable that represents the message ID for the localized text to display when the rule "fires.".
static java.lang.String DISPLAY_MEMBER
          Name of the member variable that represents the non-localized text to display when the rule "fires.".
protected  java.lang.String displayKey
          The message ID for the localized text to display when the rule "fires.".
static java.lang.String STRUCTURE_NAME
          Name of this structure within the meta-data dictionary.
 
Fields inherited from class org.eclipse.birt.report.model.api.elements.structures.StyleRule
IS_DESIGN_TIME_MEMBER, isDesignTime, operator, OPERATOR_MEMBER, TEST_EXPR_MEMBER, testExpression, value1, VALUE1_MEMBER, value2, VALUE2_MEMBER
 
Fields inherited from class org.eclipse.birt.report.model.core.PropertyStructure
propValues
 
Constructor Summary
MapRule()
          Default constructor.
MapRule(java.lang.String op, java.lang.String v1, java.lang.String v2, java.lang.String testExpre, java.lang.String id, java.lang.String disp)
          Constructs the map rule with an operator and arguments, message id if the display value is to be localized and display text if the display value is not to be localized.
 
Method Summary
 IStructureDefn getDefn()
          Returns the structure definition from the meta-data dictionary.
 java.lang.String getDisplay()
          Returns the non-localized display text.
 java.lang.String getDisplayKey()
          Returns the message ID for the text.
protected  java.lang.Object getIntrinsicProperty(java.lang.String propName)
           
 java.lang.String getStructName()
          Returns the name of the structure definition.
 StructureHandle handle(SimpleValueHandle valueHandle, int index)
           
 void setDisplay(java.lang.String text)
          Set the non-localized display text, the text is to be displayed when this rule applies.
 void setDisplayKey(java.lang.String displayKey)
          Set the message ID for the text, the text is to be displayed when this rule applies.
protected  void setIntrinsicProperty(java.lang.String propName, java.lang.Object value)
           
 
Methods inherited from class org.eclipse.birt.report.model.api.elements.structures.StyleRule
getOperator, getTestExpression, getValue1, getValue1List, getValue2, isDesignTime, setDesignTime, setOperator, setTestExpression, setValue1, setValue1, setValue2
 
Methods inherited from class org.eclipse.birt.report.model.core.PropertyStructure
clone, getLocalProperty, getLocalProperty, setProperty
 
Methods inherited from class org.eclipse.birt.report.model.core.Structure
copy, equals, getContext, getElement, getHandle, getHandle, getListMemberRef, getObjectDefn, getProperty, getProperty, getReferencableProperty, isReferencable, setContext, setProperty, updateReference, validate
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DISPLAY_MEMBER

public static final java.lang.String DISPLAY_MEMBER
Name of the member variable that represents the non-localized text to display when the rule "fires.".

See Also:
Constant Field Values

DISPLAY_ID_MEMBER

public static final java.lang.String DISPLAY_ID_MEMBER
Name of the member variable that represents the message ID for the localized text to display when the rule "fires.".

See Also:
Constant Field Values

STRUCTURE_NAME

public static final java.lang.String STRUCTURE_NAME
Name of this structure within the meta-data dictionary.

See Also:
Constant Field Values

display

protected java.lang.String display
The non-localized text to display when the rule "fires.".


displayKey

protected java.lang.String displayKey
The message ID for the localized text to display when the rule "fires.".

Constructor Detail

MapRule

public MapRule()
Default constructor.


MapRule

public MapRule(java.lang.String op,
               java.lang.String v1,
               java.lang.String v2,
               java.lang.String testExpre,
               java.lang.String id,
               java.lang.String disp)
Constructs the map rule with an operator and arguments, message id if the display value is to be localized and display text if the display value is not to be localized.

Parameters:
op - operator. One of the internal choice values identified in the meta-data dictionary
v1 - the comparison value expressions for operators that take one or two arguments (equals, like, between)
v2 - the second comparison value for operators that take two arguments (between)
testExpre - the expression to check
id - the message id if the display value is to be localized
disp - the display text if the value is not localized
Method Detail

getStructName

public java.lang.String getStructName()
Description copied from interface: IStructure
Returns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.

Returns:
the internal name of the structure a defined in the meta-data dictionary.

getIntrinsicProperty

protected java.lang.Object getIntrinsicProperty(java.lang.String propName)
Overrides:
getIntrinsicProperty in class StyleRule

setIntrinsicProperty

protected void setIntrinsicProperty(java.lang.String propName,
                                    java.lang.Object value)
Overrides:
setIntrinsicProperty in class StyleRule

getDisplayKey

public java.lang.String getDisplayKey()
Returns the message ID for the text.

Returns:
the message ID for the display text

setDisplayKey

public void setDisplayKey(java.lang.String displayKey)
Set the message ID for the text, the text is to be displayed when this rule applies.

Parameters:
displayKey - the message ID for the text.

getDisplay

public java.lang.String getDisplay()
Returns the non-localized display text.

Returns:
the non-localized display text

setDisplay

public void setDisplay(java.lang.String text)
Set the non-localized display text, the text is to be displayed when this rule applies.

Parameters:
text - the non-localized display text

getDefn

public IStructureDefn getDefn()
Description copied from interface: IStructure
Returns the structure definition from the meta-data dictionary.

Specified by:
getDefn in interface IStructure
Overrides:
getDefn in class org.eclipse.birt.report.model.core.Structure
Returns:
the structure definition

handle

public StructureHandle handle(SimpleValueHandle valueHandle,
                              int index)
Specified by:
handle in class org.eclipse.birt.report.model.core.Structure


Copyright © 2008 Actuate Corp. All rights reserved.