Class TabularCubeHandle

All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.ICubeModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.ITabularCubeModel

public class TabularCubeHandle extends CubeHandle implements org.eclipse.birt.report.model.elements.interfaces.ITabularCubeModel
Represents a cube.
See Also:
  • Cube
  • Constructor Details

    • TabularCubeHandle

      public TabularCubeHandle(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

    • getDataSet

      public DataSetHandle getDataSet()
      Returns the data set of this cube.
      Returns:
      the handle to the data set
    • setDataSet

      public void setDataSet(DataSetHandle handle) throws SemanticException
      Sets the data set of this cube.
      Parameters:
      handle - the handle of the data set
      Throws:
      SemanticException - if the property is locked, or the data-set is invalid.
    • addDimensionCondition

      public DimensionConditionHandle addDimensionCondition(DimensionCondition condition) throws SemanticException
      Adds a dimension condition to this cube.
      Parameters:
      condition -
      Returns:
      the added dimension condition handle if succeed
      Throws:
      SemanticException
    • addDimensionCondition

      public DimensionConditionHandle addDimensionCondition(DimensionCondition condition, int posn) throws SemanticException
      Adds a dimension condition to the specified position.
      Parameters:
      condition -
      posn -
      Returns:
      the added dimension condition handle if succeed
      Throws:
      SemanticException
    • joinConditionsIterator

      public Iterator joinConditionsIterator()
      Gets the iterator of the join conditions. Each one in the iterator is instance of StructureHandle.
      Returns:
      iterator of the join conditions in this cube
    • removeDimensionCondition

      public void removeDimensionCondition(DimensionCondition condition) throws SemanticException
      Removes a dimension condition from this cube.
      Parameters:
      condition -
      Throws:
      SemanticException
    • removeDimensionCondition

      public void removeDimensionCondition(DimensionConditionHandle conditionHandle) throws SemanticException
      Parameters:
      conditionHandle -
      Throws:
      SemanticException
    • findDimensionCondition

      public DimensionConditionHandle findDimensionCondition(String hierarchyName)
      Finds the dimension condition defined for the hierarchy element with the specified name.
      Parameters:
      hierarchyName -
      Returns:
      the first dimeneison condition handle if found, otherwise null
    • findDimensionCondition

      public DimensionConditionHandle findDimensionCondition(HierarchyHandle hierarchy)
      Finds the dimension condition defined for the given hierarchy element.
      Parameters:
      hierarchy -
      Returns:
      the first dimeneison condition handle if found, otherwise null
    • autoPrimaryKey

      public boolean autoPrimaryKey()
      Gets the status whether to generate a primary key for elements that use this cube so that user no longer need to set the aggregation for measure.
      Returns:
      true if automatically generate the key, otherwise false
    • setAutoPrimaryKey

      public void setAutoPrimaryKey(boolean autoKey) throws SemanticException
      Sets the status whether to generate a primary key for elements that use this cube so that user no longer need to set the aggregation for measure.
      Parameters:
      autoKey - true if automatically generate the key, otherwise false
      Throws:
      SemanticException