Package org.eclipse.birt.report.model.api.olap

Class TabularHierarchyHandle

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

org.eclipse.birt.report.model.api.olap.TabularHierarchyHandle

All Implemented Interfaces:

org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IHierarchyModel, org.eclipse.birt.report.model.elements.interfaces.ITabularHierarchyModel

public class TabularHierarchyHandle
extends HierarchyHandle
implements org.eclipse.birt.report.model.elements.interfaces.ITabularHierarchyModel

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.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, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP

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

DATA_SET_PROP, PRIMARY_KEYS_PROP

Constructor Summary

Constructors

Constructor	Description
TabularHierarchyHandle(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

Modifier and Type	Method	Description
DataSetHandle	getDataSet()	Returns the data set of this hierarchy.
java.util.List	getPrimaryKeys()	Returns the list of primary keys.
void	setDataSet(DataSetHandle handle)	Sets the data set of this hierarchy.

Methods inherited from class org.eclipse.birt.report.model.api.olap.HierarchyHandle

accessControlsIterator, filtersIterator, getLevel, getLevel, getLevelCount

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, getExpressionProperty, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindingExpression, 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, newHandlerOnEachEvent, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setBooleanProperty, setEncryption, setEventHandlerClass, setExpressionProperty, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setProperty, setPropertyBinding, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError, slotsIterator

Methods inherited from class java.lang.Object

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

Constructor Details

TabularHierarchyHandle

public TabularHierarchyHandle(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 hierarchy.

Returns:

the handle to the data set

setDataSet

public void setDataSet(DataSetHandle handle) throws SemanticException

Sets the data set of this hierarchy.

Parameters:

handle - the handle of the data set

Throws:

SemanticException - if the property is locked, or the data-set is invalid.

getPrimaryKeys

public java.util.List getPrimaryKeys()

Returns the list of primary keys. The element in the list is a String.

Returns:

a list of primary keys if set, otherwise null