Class HierarchyHandle

All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IHierarchyModel
Direct Known Subclasses:
OdaHierarchyHandle, TabularHierarchyHandle

public abstract class HierarchyHandle extends ReportElementHandle implements org.eclipse.birt.report.model.elements.interfaces.IHierarchyModel
Represents a Hierarchy.
See Also:
  • Hierarchy
  • Constructor Details

    • HierarchyHandle

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

    • getLevelCount

      public int getLevelCount()
      Gets the count of the level elements within this hierarchy.
      Returns:
      count of the level elements if set, otherwise 0
    • getLevel

      public LevelHandle getLevel(String levelName)
      Gets the level handle by the name within this hierarchy.
      Parameters:
      levelName - name of the level to find
      Returns:
      the level within this hierarchy if found, otherwise null
    • getLevel

      public LevelHandle getLevel(int index)
      Gets the level handle at the specified position within this hierarchy.
      Parameters:
      index - 0-based integer
      Returns:
      the level handle at the given index, null if index is out of range
    • filtersIterator

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

      public 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.