Package mondrian.olap

Interface Cube

All Superinterfaces:

Annotated, OlapElement

All Known Implementing Classes:

CubeBase, RolapCube

public interface Cube
extends OlapElement, Annotated

Cube.

Author:

jhyde, 2 March, 1999

Nested Class Summary

Nested classes/interfaces inherited from interface mondrian.olap.OlapElement

OlapElement.LocalizedProperty

Method Summary

Modifier and Type	Method	Description
Member	createCalculatedMember(String xml)	Creates a calculated member in this cube.
Dimension[]	getDimensions()	Returns the dimensions of this cube.
Member[]	getMembersForQuery(String query, List<Member> calcMembers)	Returns Member[].
Level	getMonthLevel()	Return Month Level or null.
String	getName()
NamedSet[]	getNamedSets()	Returns the named sets of this cube.
Level	getQuarterLevel()	Return Quarter Level or null.
Schema	getSchema()
SchemaReader	getSchemaReader(Role role)	Returns a SchemaReader for which this cube is the context for lookup up members.
Level	getWeekLevel()	Return Week Level or null.
Level	getYearLevel()	Helper method that returns the Year Level or returns null if the Time Dimension does not exist or if Year is not defined in the Time Dimension.
Hierarchy	lookupHierarchy(Id.NameSegment s, boolean unique)	Finds a hierarchy whose name (or unique name, if unique is true) equals s.
Set<Dimension>	nonJoiningDimensions(Set<Dimension> otherDims)	Finds out non joining dimensions for this cube.
Set<Dimension>	nonJoiningDimensions(Member[] tuple)	Finds out non joining dimensions for this cube.

Methods inherited from interface mondrian.olap.Annotated

getAnnotationMap

Methods inherited from interface mondrian.olap.OlapElement

getCaption, getDescription, getDimension, getHierarchy, getLocalized, getQualifiedName, getUniqueName, isVisible, lookupChild

Method Detail

getName

String getName()

Specified by:

getName in interface OlapElement

getSchema

Schema getSchema()

getDimensions

Dimension[] getDimensions()

Returns the dimensions of this cube.

getNamedSets

NamedSet[] getNamedSets()

Returns the named sets of this cube.

lookupHierarchy

Hierarchy lookupHierarchy(Id.NameSegment s,
                          boolean unique)

Finds a hierarchy whose name (or unique name, if unique is true) equals s.

getMembersForQuery

Member[] getMembersForQuery(String query,
                            List<Member> calcMembers)

Returns Member[]. It builds Member[] by analyzing cellset, which gets created by running mdx sQuery. query has to be in the format of something like "[with calculated members] select *members* on columns from this".

getYearLevel

Level getYearLevel()

Helper method that returns the Year Level or returns null if the Time Dimension does not exist or if Year is not defined in the Time Dimension.

Returns:

Level or null.

getQuarterLevel

Level getQuarterLevel()

Return Quarter Level or null.

Returns:

Quarter Level or null.

getMonthLevel

Level getMonthLevel()

Return Month Level or null.

Returns:

Month Level or null.

getWeekLevel

Level getWeekLevel()

Return Week Level or null.

Returns:

Week Level or null.

getSchemaReader

SchemaReader getSchemaReader(Role role)

Returns a SchemaReader for which this cube is the context for lookup up members. If role is null, the returned schema reader also obeys the access-control profile of role.

createCalculatedMember

Member createCalculatedMember(String xml)

Creates a calculated member in this cube.

The XML string must be a <CalculatedMember/> element, as defined in Mondrian.xml.

Parameters:

xml - XML string

nonJoiningDimensions

Set<Dimension> nonJoiningDimensions(Member[] tuple)

Finds out non joining dimensions for this cube.

Parameters:

tuple - array of members

Returns:

Set of dimensions that do not exist (non joining) in this cube

nonJoiningDimensions

Set<Dimension> nonJoiningDimensions(Set<Dimension> otherDims)

Finds out non joining dimensions for this cube.

Parameters:

otherDims - Set of dimensions to be tested for existence in this cube

Returns:

Set of dimensions that do not exist (non joining) in this cube