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

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

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.ICubeModel
ACCESS_CONTROLS_PROP, DEFAULT_MEASURE_GROUP_PROP, DIMENSIONS_PROP, FILTER_PROP, MEASURE_GROUPS_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
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.
 
Method Summary
 java.util.Iterator accessControlsIterator()
          Returns an iterator for the access controls.
 void addFilter(FilterCondition fc)
          Adds the filter condition.
 java.util.Iterator filtersIterator()
          Returns an iterator for the filter list defined on this cube.
 MeasureGroupHandle getDefaultMeasureGroup()
          Gets the default measure group for the cube.
 DimensionHandle getDimension(java.lang.String dimensionName)
          Gets the dimension with the specified name within this cube.
 MeasureHandle getMeasure(java.lang.String measureName)
          Gets the measure with the specified name within this cube.
 void removeFilter(FilterCondition fc)
          Removes the filter condition.
 void setDefaultMeasureGroup(MeasureGroupHandle defaultMeasureGroup)
          Sets the default measure group for this cube.
 
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

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)
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

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

public MeasureGroupHandle getDefaultMeasureGroup()
Gets the default measure group for the cube.

Returns:
the default measure group

setDefaultMeasureGroup

public void setDefaultMeasureGroup(MeasureGroupHandle defaultMeasureGroup)
                            throws SemanticException
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.

addFilter

public void addFilter(FilterCondition fc)
               throws SemanticException
Adds the filter condition.

Parameters:
fc - the filter condition structure
Throws:
SemanticException - if the expression of filter condition is empty or null

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


Copyright © 2008 Actuate Corp. All rights reserved.