Class CubeHandle

  • All Implemented Interfaces:
    org.eclipse.birt.report.model.elements.interfaces.ICubeModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
    Direct Known Subclasses:
    OdaCubeHandle, TabularCubeHandle

    public abstract class CubeHandle
    extends ReportElementHandle
    implements org.eclipse.birt.report.model.elements.interfaces.ICubeModel
    Represents a cube.
    See Also:
    Cube
    • Constructor Detail

      • CubeHandle

        public CubeHandle​(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 Detail

      • getDimension

        public DimensionHandle getDimension​(java.lang.String dimensionName,
                                            boolean needLevelForTimeDimension)
      • getDimension

        public DimensionHandle getDimension​(java.lang.String dimensionName)
        Gets the dimension with the specified name within this cube.
        Parameters:
        dimensionName - name of the dimension to find
        Returns:
        dimension within the cube if found, otherwise null
      • getLocalDimension

        public DimensionHandle getLocalDimension​(java.lang.String dimensionName)
        Gets the dimension with the specified name within this cube. If dimension defined with the given name doesn't exist, it returns the local corresponding one mapped to the parent dimension that matches the given name.
        Parameters:
        dimensionName - name of the dimension to find
        Returns:
        dimension within the cube if found, otherwise null
      • doGetLocalDimension

        protected org.eclipse.birt.report.model.core.DesignElement doGetLocalDimension​(java.lang.String dimensionName,
                                                                                       org.eclipse.birt.report.model.elements.olap.Cube parent,
                                                                                       org.eclipse.birt.report.model.core.Module parentModule)
        Returns the dimension defined on the given cube.
        Parameters:
        dimensionName -
        parent -
        parentModule -
        Returns:
      • getMeasure

        public MeasureHandle getMeasure​(java.lang.String measureName)
        Gets the measure with the specified name within this cube.
        Parameters:
        measureName - name of the measure to find
        Returns:
        measure within the cube if found, otherwise null
      • filtersIterator

        public java.util.Iterator filtersIterator()
        Returns an iterator for the filter list defined on this cube. Each object returned is of type StructureHandle.
        Returns:
        the iterator for FilterCond structure list defined on this cube.
      • getDefaultMeasureGroup

        @Deprecated
        public MeasureGroupHandle getDefaultMeasureGroup()
        Deprecated.
        Gets the default measure group for the cube.
        Returns:
        the default measure group
      • setDefaultMeasureGroup

        @Deprecated
        public void setDefaultMeasureGroup​(MeasureGroupHandle defaultMeasureGroup)
                                    throws SemanticException
        Deprecated.
        Sets the default measure group for this cube.
        Parameters:
        defaultMeasureGroup - the default measure group to set
        Throws:
        SemanticException
      • accessControlsIterator

        public java.util.Iterator accessControlsIterator()
        Returns an iterator for the access controls. Each object returned is of type AccessControlHandle.
        Returns:
        the iterator for user accesses defined on this cube.
      • removeFilter

        public void removeFilter​(FilterCondition fc)
                          throws SemanticException
        Removes the filter condition.
        Parameters:
        fc - the filter condition structure
        Throws:
        SemanticException - if the given condition doesn't exist in the filters
      • getACLExpression

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