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

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

Method Detail

getUniqueName

String getUniqueName()

getName

String getName()

getDescription

String getDescription()

lookupChild

OlapElement lookupChild(SchemaReader schemaReader,
                        Id.Segment s)

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

lookupChild

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

getQualifiedName

String getQualifiedName()

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

getCaption

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