org.eclipse.birt.report.model.api.olap
Class HierarchyHandle

java.lang.Object
  org.eclipse.birt.report.model.api.DesignElementHandle
      org.eclipse.birt.report.model.api.ReportElementHandle
          org.eclipse.birt.report.model.api.olap.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

Field Summary

Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle

element

Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle

module

Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IHierarchyModel

ACCESS_CONTROLS_PROP, FILTER_PROP, LEVELS_PROP

Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel

COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP

Constructor Summary

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.

Method Summary

java.util.Iterator	accessControlsIterator() Returns an iterator for the access controls.
java.util.Iterator	filtersIterator() Returns an iterator for the filter list defined on this hierarchy.
LevelHandle	getLevel(int index) Gets the level handle at the specified position within this hierarchy.
LevelHandle	getLevel(java.lang.String levelName) Gets the level handle by the name within this hierarchy.
int	getLevelCount() Gets the count of the level elements within this hierarchy.

Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle

getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask

Methods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle

add, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, drop, drop, dropAndClear, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setEncryption, setEventHandlerClass, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNumberProperty, setProperties, setProperty, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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 Detail

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(java.lang.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 java.util.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 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.