|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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
public class MapRule
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 |
---|
public static final java.lang.String DISPLAY_MEMBER
public static final java.lang.String DISPLAY_ID_MEMBER
public static final java.lang.String STRUCTURE_NAME
protected java.lang.String display
protected java.lang.String displayKey
Constructor Detail |
---|
public 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)
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 localizedMethod Detail |
---|
public java.lang.String getStructName()
IStructure
protected java.lang.Object getIntrinsicProperty(java.lang.String propName)
getIntrinsicProperty
in class StyleRule
protected void setIntrinsicProperty(java.lang.String propName, java.lang.Object value)
setIntrinsicProperty
in class StyleRule
public java.lang.String getDisplayKey()
public void setDisplayKey(java.lang.String displayKey)
displayKey
- the message ID for the text.public java.lang.String getDisplay()
public void setDisplay(java.lang.String text)
text
- the non-localized display textpublic IStructureDefn getDefn()
IStructure
getDefn
in interface IStructure
getDefn
in class org.eclipse.birt.report.model.core.Structure
public StructureHandle handle(SimpleValueHandle valueHandle, int index)
handle
in class org.eclipse.birt.report.model.core.Structure
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |