Class DimensionHandle
- java.lang.Object
-
- org.eclipse.birt.report.model.api.DesignElementHandle
-
- org.eclipse.birt.report.model.api.ReportElementHandle
-
- org.eclipse.birt.report.model.api.olap.DimensionHandle
-
- All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
,org.eclipse.birt.report.model.elements.interfaces.IDimensionModel
- Direct Known Subclasses:
OdaDimensionHandle
,TabularDimensionHandle
public abstract class DimensionHandle extends ReportElementHandle implements org.eclipse.birt.report.model.elements.interfaces.IDimensionModel
Represents a dimension element in the cube element.- See Also:
Dimension
-
-
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
-
-
Constructor Summary
Constructors Constructor Description DimensionHandle(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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExpressionHandle
getACLExpression()
Gets the expression handle for theACLExpression
property.java.util.List<CubeHandle>
getCubeClients()
HierarchyHandle
getDefaultHierarchy()
Gets the default hierarchy for the dimension.boolean
isTimeType()
Indicates whether this dimension is a special type of Time.void
setDefaultHierarchy(HierarchyHandle defaultHierarchy)
Sets the default hierarchy for this dimension.void
setTimeType(boolean isTimeType)
Sets the status to indicate whether this dimension is a special type of Time.-
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
-
-
-
-
Constructor Detail
-
DimensionHandle
public DimensionHandle(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 moduleelement
- the model representation of the element
-
-
Method Detail
-
isTimeType
public boolean isTimeType()
Indicates whether this dimension is a special type of Time.- Returns:
- true if this dimension is of Time type, otherwise false
-
setTimeType
public void setTimeType(boolean isTimeType) throws SemanticException
Sets the status to indicate whether this dimension is a special type of Time.- Parameters:
isTimeType
- status whether this dimension is of Time type- Throws:
SemanticException
- the property is locked
-
getDefaultHierarchy
public HierarchyHandle getDefaultHierarchy()
Gets the default hierarchy for the dimension.- Returns:
- the default hierarchy for this dimension
-
setDefaultHierarchy
public void setDefaultHierarchy(HierarchyHandle defaultHierarchy) throws SemanticException
Sets the default hierarchy for this dimension.- Parameters:
defaultHierarchy
- the default hierarchy to set- Throws:
SemanticException
-
getACLExpression
public ExpressionHandle getACLExpression()
Gets the expression handle for theACLExpression
property.- Returns:
-
getCubeClients
public java.util.List<CubeHandle> getCubeClients()
- Returns:
-
-