mondrian.olap

Interface OlapElement

All Known Subinterfaces:

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

All Known Implementing Classes:

CubeBase, DelegatingRolapMember, DimensionBase, HierarchyBase, LevelBase, MemberBase, OlapElementBase, Query.ScopedNamedSet, RolapBaseCubeMeasure, RolapCalculatedMember, RolapCube, RolapCubeDimension, RolapCubeHierarchy, RolapCubeLevel, RolapCubeMember, RolapHierarchy, RolapHierarchy.LimitedRollupMember, RolapHierarchy.RolapCalculatedMeasure, RolapLevel, RolapMemberBase, RolapResult.CompoundSlicerRolapMember, RolapVirtualCubeMeasure, SetBase, VisualTotalsFunDef.VisualTotalMember

public interface OlapElement

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

Author:

jhyde, 21 January, 1999

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OlapElement.LocalizedProperty

Method Summary

Modifier and Type	Method and Description
String	getCaption()
String	getDescription()
Dimension	getDimension() Returns the dimension of a this expression, or null if no dimension is defined.
Hierarchy	getHierarchy()
String	getLocalized(OlapElement.LocalizedProperty prop, Locale locale) Returns the value of a property (caption or description) of this element in the given locale.
String	getName()
String	getQualifiedName() Returns the name of this element qualified by its class, for example "hierarchy 'Customers'".
String	getUniqueName()
boolean	isVisible() Returns whether this element is visible to end-users.
OlapElement	lookupChild(SchemaReader schemaReader, Id.Segment s, MatchType matchType) Looks up a child element, returning null if it does not exist.

Method Detail

getUniqueName

String getUniqueName()

getName

String getName()

getDescription

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

String getQualifiedName()

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

getCaption

String getCaption()

getLocalized

String getLocalized(OlapElement.LocalizedProperty prop,
                    Locale locale)

Returns the value of a property (caption or description) of this element in the given locale.

Parameters:

locale - Locale

Returns:

Localized caption or description

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

isVisible

boolean isVisible()

Returns whether this element is visible to end-users.

Visibility is a hint for client applications. An element's visibility does not affect how it is treated when MDX queries are evaluated.

Returns:

Whether this element is visible