Class MapRule
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.PropertyStructure
org.eclipse.birt.report.model.api.elements.structures.StyleRule
org.eclipse.birt.report.model.api.elements.structures.MapRule
- All Implemented Interfaces:
Cloneable,IStructure,org.eclipse.birt.report.model.core.IPropertySet
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
FieldsModifier and TypeFieldDescriptionprotected StringThe non-localized text to display when the rule "fires.".static final StringName of the member variable that represents the message ID for the localized text to display when the rule "fires.".static final StringName of the member variable that represents the non-localized text to display when the rule "fires.".protected StringThe message ID for the localized text to display when the rule "fires.".static final StringName 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_MEMBERFields inherited from class org.eclipse.birt.report.model.core.PropertyStructure
propValues -
Constructor Summary
ConstructorsConstructorDescriptionMapRule()Default constructor.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
Modifier and TypeMethodDescriptiongetDefn()Gets the structure definition by the name of this structure.Returns the non-localized display text.Returns the message ID for the text.protected ObjectgetIntrinsicProperty(String propName) Returns the value of a structure property represented as a member variable.Returns the name of the structure definition.handle(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.voidsetDisplay(String text) Set the non-localized display text, the text is to be displayed when this rule applies.voidsetDisplayKey(String displayKey) Set the message ID for the text, the text is to be displayed when this rule applies.protected voidsetIntrinsicProperty(String propName, Object value) Sets the value of of a structure property represented as a member variable.Methods inherited from class org.eclipse.birt.report.model.api.elements.structures.StyleRule
getOperator, getTestExpression, getValue1, getValue1ExpressionList, getValue1List, getValue2, isDesignTime, setDesignTime, setOperator, setTestExpression, setValue1, setValue1, setValue2Methods inherited from class org.eclipse.birt.report.model.core.PropertyStructure
clone, getLocalProperty, getLocalProperty, setPropertyMethods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getElement, getExpressionProperty, getHandle, getHandle, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isReferencable, setContext, setExpressionProperty, setProperty, setupContext, updateReference, validate
-
Field Details
-
DISPLAY_MEMBER
Name of the member variable that represents the non-localized text to display when the rule "fires.".- See Also:
-
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:
-
STRUCTURE_NAME
Name of this structure within the meta-data dictionary.- See Also:
-
display
The non-localized text to display when the rule "fires.". -
displayKey
The message ID for the localized text to display when the rule "fires.".
-
-
Constructor Details
-
MapRule
public MapRule()Default constructor. -
MapRule
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 dictionaryv1- 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 checkid- the message id if the display value is to be localizeddisp- the display text if the value is not localized
-
-
Method Details
-
getStructName
Description copied from interface:IStructureReturns 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
Description copied from class:org.eclipse.birt.report.model.core.StructureReturns the value of a structure property represented as a member variable.- Overrides:
getIntrinsicPropertyin classStyleRule- Parameters:
propName- name of the property- Returns:
- the value of the property, or null if the property is not set
-
setIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.StructureSets the value of of a structure property represented as a member variable.- Overrides:
setIntrinsicPropertyin classStyleRule- Parameters:
propName- the name of the property to setvalue- the property value
-
getDisplayKey
Returns the message ID for the text.- Returns:
- the message ID for the display text
-
setDisplayKey
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
Returns the non-localized display text.- Returns:
- the non-localized display text
-
setDisplay
Set the non-localized display text, the text is to be displayed when this rule applies.- Parameters:
text- the non-localized display text
-
getDefn
Description copied from class:org.eclipse.birt.report.model.core.StructureGets the structure definition by the name of this structure.- Specified by:
getDefnin interfaceIStructure- Overrides:
getDefnin classorg.eclipse.birt.report.model.core.Structure- Returns:
- structure definition.
-
handle
Description copied from class:org.eclipse.birt.report.model.core.StructureCreates the specific handle of this structure. This handle is always created.- Specified by:
handlein classorg.eclipse.birt.report.model.core.Structure- Parameters:
valueHandle- the value handle of this structure list property this structure is inindex- the position of this structure in structure list- Returns:
- the handle of this structure.
-