mondrian.olap
Interface OlapElement

All Known Subinterfaces:

Cube, Dimension, Hierarchy, Level, Member, NamedSet, RolapMeasure, RolapStoredMeasure

All Known Implementing Classes:

CubeBase, DimensionBase, HierarchyBase, LevelBase, MemberBase, MemberHelperTest.TestMember, OlapElementBase, Query.ScopedNamedSet, RolapBaseCubeMeasure, RolapCalculatedMember, RolapCube, RolapCubeDimension, RolapCubeHierarchy, RolapCubeLevel, RolapCubeMember, RolapDimension, RolapHierarchy, RolapHierarchy.LimitedRollupMember, RolapHierarchy.RolapCalculatedMeasure, RolapHierarchy.RolapNullMember, RolapLevel, RolapMember, RolapVirtualCubeMeasure, SetBase, TestMember

public interface OlapElement

An OlapElement is a catalog object (dimension, hierarchy, level, member).

Method Summary

java.lang.String	getCaption()
java.lang.String	getDescription()
Dimension	getDimension() Returns the dimension of a this expression, or null if no dimension is defined.
Hierarchy	getHierarchy()
java.lang.String	getName()
java.lang.String	getQualifiedName() Returns the name of this element qualified by its class, for example "hierarchy 'Customers'".
java.lang.String	getUniqueName()
OlapElement	lookupChild(SchemaReader schemaReader, Id.Segment s, MatchType matchType) Looks up a child element, returning null if it does not exist.

Method Detail

getUniqueName

java.lang.String getUniqueName()

getName

java.lang.String getName()

getDescription

java.lang.String getDescription()

lookupChild

OlapElement lookupChild(SchemaReader schemaReader,
                        Id.Segment s,
                        MatchType matchType)

Looks up a child element, returning null if it does not exist.

getQualifiedName

java.lang.String getQualifiedName()

Returns the name of this element qualified by its class, for example "hierarchy 'Customers'".

getCaption

java.lang.String getCaption()

getHierarchy

Hierarchy getHierarchy()

getDimension

Dimension getDimension()

Returns the dimension of a this expression, or null if no dimension is defined. Applicable only to set expressions.

Example 1:

 [Sales].children
 

has dimension [Sales].

Example 2:

 order(except([Promotion Media].[Media Type].members,
              {[Promotion Media].[Media Type].[No Media]}),
       [Measures].[Unit Sales], DESC)
 

has dimension [Promotion Media].

Example 3:

 CrossJoin([Product].[Product Department].members,
           [Gender].members)
 

has no dimension (well, actually it is [Product] x [Gender], but we can't represent that, so we return null);