org.eclipse.birt.report.model.api
Class StyleRuleHandle

java.lang.Object
  extended by org.eclipse.birt.report.model.api.ElementDetailHandle
      extended by org.eclipse.birt.report.model.api.ValueHandle
          extended by org.eclipse.birt.report.model.api.StructureHandle
              extended by org.eclipse.birt.report.model.api.StyleRuleHandle
Direct Known Subclasses:
HighlightRuleHandle, MapRuleHandle

public abstract class StyleRuleHandle
extends StructureHandle

Represents the handle of style rule. This abstract class provides the common methods for HighlightRuleHandle and MapRuleHandle. The style rule provides the operator, value1, and value2 to compute boolean result.


Field Summary
 
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structRef
 
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
 
Constructor Summary
StyleRuleHandle(SimpleValueHandle valueHandle, int index)
          Constructs the handle of style rule.
 
Method Summary
 java.lang.String getOperator()
          Returns the operator.
 java.lang.String getValue1()
          Returns the value 1.
 java.util.List getValue1List()
          Gets the value1 expression list.
 java.lang.String getValue2()
          Returns the value 2.
 void setOperator(java.lang.String operator)
          Sets the operator.
 void setValue1(java.util.List value1List)
          Sets the value 1 expression list.
 void setValue1(java.lang.String value1)
          Sets the value 1.
 void setValue2(java.lang.String value2)
          Sets the value 2.
 
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getDefn, getExternalizedValue, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently
 
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StyleRuleHandle

public StyleRuleHandle(SimpleValueHandle valueHandle,
                       int index)
Constructs the handle of style rule.

Parameters:
valueHandle - the value handle for style rule list of one property
index - the position of this style rule in the list
Method Detail

getOperator

public java.lang.String getOperator()
Returns the operator. The possible values are defined in DesignChoiceConstants, and they are:

Returns:
the operator

setOperator

public void setOperator(java.lang.String operator)
                 throws SemanticException
Sets the operator. The allowed values are defined in DesignChoiceConstants, and they are:

Parameters:
operator - the operator to set
Throws:
SemanticException - if operator is not in the choice list.

getValue1

public java.lang.String getValue1()
Returns the value 1.

Returns:
the value 1

getValue1List

public java.util.List getValue1List()
Gets the value1 expression list. For most map operator, there is only one expression in the returned list. However, map operator 'in' may contain more than one expression.

Returns:
the value1 expression list.

setValue1

public void setValue1(java.lang.String value1)
Sets the value 1.

Parameters:
value1 - the value 1 to set

setValue1

public void setValue1(java.util.List value1List)
               throws SemanticException
Sets the value 1 expression list.

Parameters:
value1List - the value 1 expression list to set
Throws:
SemanticException - if the instance in the list is not valid

getValue2

public java.lang.String getValue2()
Returns the value 2.

Returns:
the value 2

setValue2

public void setValue2(java.lang.String value2)
Sets the value 2.

Parameters:
value2 - the value 2 to set


Copyright © 2008 Actuate Corp. All rights reserved.