Class MeasureHandle

All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IMeasureModel
Direct Known Subclasses:
OdaMeasureHandle, TabularMeasureHandle

public abstract class MeasureHandle extends ReportElementHandle implements org.eclipse.birt.report.model.elements.interfaces.IMeasureModel
This class represents a measure element.
  • Constructor Details

    • MeasureHandle

      public MeasureHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
      Constructs a handle for the given design and design element. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.
      Parameters:
      module - the module
      element - the model representation of the element
  • Method Details

    • getFunction

      public String getFunction()
      Gets the function defined in this measure.
      Returns:
      function for this measure
    • setFunction

      public void setFunction(String function) throws SemanticException
      Sets the function for this measure.
      Parameters:
      function - the function to set
      Throws:
      SemanticException - property is locked or value is invalid
    • getMeasureExpression

      public String getMeasureExpression()
      Gets the measure expression of this measure element.
      Returns:
      measure expression of this measure element
    • setMeasureExpression

      public void setMeasureExpression(String expression) throws SemanticException
      Sets the measure expression for this measure.
      Parameters:
      expression - the measure expression to set
      Throws:
      SemanticException - property is locked
    • isCalculated

      public boolean isCalculated()
      Indicates whether this measure is computed by other measures or not.
      Returns:
      true if this measure is computed by other measures, otherwise false
    • setCalculated

      public void setCalculated(boolean isCalculated) throws SemanticException
      Sets whether this measure is computed by other measures or not.
      Parameters:
      isCalculated - true if this measure is computed by other measures, otherwise false
      Throws:
      SemanticException - property is locked
    • getDataType

      public String getDataType()
      Returns the data type information of this measure. The possible values are defined in DesignChoiceConstants, and they are:
      • COLUMN_DATA_TYPE_INTEGER
      • COLUMN_DATA_TYPE_STRING
      • COLUMN_DATA_TYPE_DATETIME
      • COLUMN_DATA_TYPE_DECIMAL
      • COLUMN_DATA_TYPE_FLOAT
      • COLUMN_DATA_TYPE_STRUCTURE
      • COLUMN_DATA_TYPE_TABLE
      Returns:
      the data type of this measure.
    • setDataType

      public void setDataType(String dataType) throws SemanticException
      Sets the data type of this measure. The allowed values are defined in DesignChoiceConstants, and they are:
      • COLUMN_DATA_TYPE_INTEGER
      • COLUMN_DATA_TYPE_STRING
      • COLUMN_DATA_TYPE_DATETIME
      • COLUMN_DATA_TYPE_DECIMAL
      • COLUMN_DATA_TYPE_FLOAT
      • COLUMN_DATA_TYPE_STRUCTURE
      • COLUMN_DATA_TYPE_TABLE
      Parameters:
      dataType - the data type to set
      Throws:
      SemanticException - if the dataType is not in the choice list.
    • getACLExpression

      public ExpressionHandle getACLExpression()
      Gets the expression handle for the ACLExpression property.
      Returns:
    • getActionHandle

      public ActionHandle getActionHandle()
      Returns a handle to work with the action property, action is a structure that defines a hyperlink.
      Returns:
      a handle to the action property, return null if the action has not been set on the measure.
      See Also:
    • setAction

      public ActionHandle setAction(Action action) throws SemanticException
      Set an action on the measure.
      Parameters:
      action - new action to be set on the measure, it represents a bookmark link, hyper-link, and drill through etc.
      Returns:
      a handle to the action property, return null if the action has not been set on the measure.
      Throws:
      SemanticException - if member of the action is not valid.
    • actionsIterator

      public Iterator<ActionHandle> actionsIterator()
      Returns the iterator for action defined on this measure.
      Returns:
      the iterator for Action structure list defined on this measure
    • getFormat

      public FormatValueHandle getFormat()
      Gets the format of the measure.
      Returns:
      the format, or null if not set.
    • setFormat

      public void setFormat(FormatValue format) throws SemanticException
      Sets the format of the measure.
      Parameters:
      format - the format to set.
      Throws:
      SemanticException
    • getAlignment

      public String getAlignment()
      Gets the alignment of the measure. The returned value may be one of the following constants defined in DesignChoiceConstants:
      • TEXT_ALIGN_LEFT
      • TEXT_ALIGN_CENTER
      • TEXT_ALIGN_RIGHT
      • TEXT_ALIGN_JUSTIFY
      Returns:
      the alignment of the measure.
    • setAlignment

      public void setAlignment(String alignment) throws SemanticException
      Sets the alignment of the measure. The value to set should be one of the following constants defined in DesignChoiceConstants:
      • TEXT_ALIGN_LEFT
      • TEXT_ALIGN_CENTER
      • TEXT_ALIGN_RIGHT
      • TEXT_ALIGN_JUSTIFY
      Parameters:
      alignment - the new alignment to set.
      Throws:
      SemanticException
    • isVisible

      public boolean isVisible()
      Gets the status whether the measure element is visible or not. By default, it is true.
      Returns:
    • setVisible

      public void setVisible(boolean isVisible) throws SemanticException
      Sets the status whether the measure element is visible or not.
      Parameters:
      isVisible -
      Throws:
      SemanticException