mondrian.rolap

Class RolapCubeMember

java.lang.Object

mondrian.olap.OlapElementBase

mondrian.olap.MemberBase

mondrian.rolap.RolapMemberBase

mondrian.rolap.DelegatingRolapMember

mondrian.rolap.RolapCubeMember

All Implemented Interfaces:

Comparable, Annotated, Member, OlapElement, RolapMember, RolapMemberInCube

Direct Known Subclasses:

RolapHierarchy.LimitedRollupMember

public class RolapCubeMember
extends DelegatingRolapMember
implements RolapMemberInCube

RolapCubeMember wraps RolapMembers and binds them to a specific cube. RolapCubeMember wraps or overrides RolapMember methods that directly reference the wrapped Member. Methods that only contain calls to other methods do not need wrapped.

Author:

Will Gorman, 19 October 2007

Nested Class Summary

Nested classes/interfaces inherited from class mondrian.rolap.RolapMemberBase

RolapMemberBase.DefaultPropertyValueMapFactory, RolapMemberBase.PropertyValueMapFactory, RolapMemberBase.PropertyValueMapFactoryFactory

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

Member.MemberType

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

OlapElement.LocalizedProperty

Field Summary

Fields

Modifier and Type	Field and Description
protected RolapCubeLevel	cubeLevel
protected RolapCubeMember	parentCubeMember

Fields inherited from class mondrian.rolap.DelegatingRolapMember

member

Fields inherited from class mondrian.olap.MemberBase

flags, level, parentMember, uniqueName

Fields inherited from class mondrian.olap.OlapElementBase

caption, visible

Constructor Summary

Constructors

Constructor and Description
RolapCubeMember(RolapCubeMember parent, RolapMember member, RolapCubeLevel cubeLevel) Creates a RolapCubeMember.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o) Compares this member to another RolapMemberBase.
boolean	containsAggregateFunction() Returns whether this calculation contains an aggregate function.
boolean	equals(Object o)
boolean	equals(OlapElement o)
Calc	getCompiledExpression(mondrian.rolap.RolapEvaluatorRoot root) Returns the compiled expression to evaluate the scalar value of the current cell.
RolapCube	getCube() Returns the cube this cube member belongs to.
RolapCubeMember	getDataMember() Returns the system-generated data member that is associated with a nonleaf member of a dimension.
RolapCubeDimension	getDimension() Returns the dimension of a this expression, or null if no dimension is defined.
Exp	getExpression() Returns the expression by which this member is calculated.
RolapCubeHierarchy	getHierarchy()
int	getHierarchyOrdinal() Returns the ordinal of this calculation; to resolve ties.
RolapCubeLevel	getLevel()
RolapCubeMember	getParentMember() Returns this member's parent, or null (not the 'null member', as returned by Hierarchy.getNullMember()) if it has no parent.
Object	getPropertyValue(String propertyName) Returns the value of the property named propertyName.
Object	getPropertyValue(String propertyName, boolean matchCase) Returns the value of the property named propertyName, matching according to the required case-sensitivity.
RolapMember	getRolapMember() Returns the underlying member.
int	getSolveOrder() Returns the solve order of this calculation.
String	getUniqueName()
int	hashCode()
boolean	isCalculatedInQuery() Returns whether this calculation is a member is computed from a WITH MEMBER clause in an MDX query.
OlapElement	lookupChild(SchemaReader schemaReader, Id.Segment childName, MatchType matchType) Looks up a child element, returning null if it does not exist.
void	setContextIn(RolapEvaluator evaluator) Pushes this calculated member or tuple onto the stack of evaluation contexts, and sets the context to the default member of the hierarchy.
void	setProperty(String name, Object value) Sets a property of this member to a given value.
String	toString()

Methods inherited from class mondrian.rolap.DelegatingRolapMember

getAncestorMembers, getAnnotationMap, getCaption, getDepth, getDescription, getKey, getMemberType, getName, getOrderKey, getOrdinal, getParentUniqueName, getProperties, getPropertyFormattedValue, getQualifiedName, getSolveOrder, isAll, isAllMember, isCalculated, isCalculatedInQuery, isChildOrEqualTo, isEvaluated, isHidden, isMeasure, isNull, isParentChildLeaf, isParentChildPhysicalMember, setName

Methods inherited from class mondrian.rolap.RolapMemberBase

childLevelHasApproxRowCount, containsAggregateFunction, getAllMembers, getCaptionValue, getCompiledExpression, getHierarchyCardinality, getHierarchyOrdinal, getLogger, getPropertyFromMap, keyToString, setCaptionValue, setContextIn, setOrdinal, setOrdinals, setUniqueName

Methods inherited from class mondrian.olap.MemberBase

computeCalculated, isChildOrEqualTo, isOnSameHierarchyChain, isOnSameHierarchyChainInternal

Methods inherited from class mondrian.olap.OlapElementBase

clone, computeHashCode, getLocalized, isVisible, setCaption

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mondrian.rolap.RolapMember

getKey, isAllMember

Methods inherited from interface mondrian.olap.Member

getAncestorMembers, getDepth, getMemberType, getOrderKey, getOrdinal, getParentUniqueName, getProperties, getPropertyFormattedValue, getSolveOrder, isAll, isCalculated, isCalculatedInQuery, isChildOrEqualTo, isEvaluated, isHidden, isMeasure, isNull, isOnSameHierarchyChain, isParentChildLeaf, isParentChildPhysicalMember, setName

Methods inherited from interface mondrian.olap.OlapElement

getCaption, getDescription, getLocalized, getName, getQualifiedName, isVisible

Methods inherited from interface mondrian.olap.Annotated

getAnnotationMap

Field Detail

cubeLevel

protected final RolapCubeLevel cubeLevel

parentCubeMember

protected final RolapCubeMember parentCubeMember

Constructor Detail

RolapCubeMember

public RolapCubeMember(RolapCubeMember parent,
                       RolapMember member,
                       RolapCubeLevel cubeLevel)

Creates a RolapCubeMember.

Parameters:

parent - Parent member

member - Member of underlying (non-cube) hierarchy

cubeLevel - Level

Method Detail

getUniqueName

public String getUniqueName()

Specified by:

getUniqueName in interface OlapElement

Overrides:

getUniqueName in class DelegatingRolapMember

getRolapMember

public final RolapMember getRolapMember()

Returns the underlying member. This is a member of a shared dimension and does not belong to a cube.

Returns:

Underlying member

getCube

public final RolapCube getCube()

Description copied from interface: RolapMemberInCube

Returns the cube this cube member belongs to.

This method is not in the RolapMember interface, because regular members may be shared, and therefore do not belong to a specific cube.

Specified by:

getCube in interface RolapMemberInCube

Returns:

Cube this cube member belongs to, never null

getDataMember

public final RolapCubeMember getDataMember()

Description copied from interface: Member

Returns the system-generated data member that is associated with a nonleaf member of a dimension.

Returns this member if this member is a leaf member, or if the nonleaf member does not have an associated data member.

Specified by:

getDataMember in interface Member

Overrides:

getDataMember in class DelegatingRolapMember

compareTo

public int compareTo(Object o)

Description copied from class: RolapMemberBase

Compares this member to another RolapMemberBase.

The method first compares on keys; null keys always collate last. If the keys are equal, it compares using unique name.

This method does not consider RolapMemberBase.ordinal field, because ordinal is only unique within a parent. If you want to compare members which may be at any position in the hierarchy, use FunUtil.compareHierarchically(mondrian.olap.Member, mondrian.olap.Member, boolean).

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class DelegatingRolapMember

Returns:

-1 if this is less, 0 if this is the same, 1 if this is greater

toString

public String toString()

Overrides:

toString in class OlapElementBase

hashCode

public int hashCode()

Overrides:

hashCode in class RolapMemberBase

equals

public boolean equals(Object o)

Overrides:

equals in class RolapMemberBase

equals

public boolean equals(OlapElement o)

Overrides:

equals in class RolapMemberBase

getHierarchy

public final RolapCubeHierarchy getHierarchy()

Specified by:

getHierarchy in interface Member

Specified by:

getHierarchy in interface OlapElement

Specified by:

getHierarchy in interface RolapMember

Overrides:

getHierarchy in class DelegatingRolapMember

getDimension

public final RolapCubeDimension getDimension()

Description copied from interface: OlapElement

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

Specified by:

getDimension in interface OlapElement

Overrides:

getDimension in class DelegatingRolapMember

getLevel

public final RolapCubeLevel getLevel()

This method is central to how RolapCubeMember works. It allows a member from the cache to be used within different usages of the same shared dimension. The cache member is the same, but the RolapCubeMembers wrapping the cache member report that they belong to different levels, and hence different hierarchies, dimensions, and cubes.

Specified by:

getLevel in interface Member

Specified by:

getLevel in interface RolapMember

Overrides:

getLevel in class DelegatingRolapMember

setProperty

public void setProperty(String name,
                        Object value)

Description copied from class: RolapMemberBase

Sets a property of this member to a given value.

WARNING: Setting system properties such as "$name" may have nasty side-effects.

Specified by:

setProperty in interface Member

Overrides:

setProperty in class DelegatingRolapMember

getPropertyValue

public Object getPropertyValue(String propertyName,
                               boolean matchCase)

Description copied from interface: Member

Returns the value of the property named propertyName, matching according to the required case-sensitivity.

Specified by:

getPropertyValue in interface Member

Overrides:

getPropertyValue in class DelegatingRolapMember

getPropertyValue

public Object getPropertyValue(String propertyName)

Description copied from interface: Member

Returns the value of the property named propertyName. Name match is case-sensitive.

Specified by:

getPropertyValue in interface Member

Overrides:

getPropertyValue in class DelegatingRolapMember

getParentMember

public final RolapCubeMember getParentMember()

Description copied from interface: Member

Returns this member's parent, or null (not the 'null member', as returned by Hierarchy.getNullMember()) if it has no parent.

In an access-control context, a member may have no visible parents, so use SchemaReader.getMemberParent(mondrian.olap.Member).

Specified by:

getParentMember in interface Member

Specified by:

getParentMember in interface RolapMember

Overrides:

getParentMember in class DelegatingRolapMember

getExpression

public Exp getExpression()

Description copied from class: MemberBase

Returns the expression by which this member is calculated. The expression is not null if and only if the member is not calculated.

Specified by:

getExpression in interface Member

Overrides:

getExpression in class DelegatingRolapMember

lookupChild

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

Description copied from interface: OlapElement

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

Specified by:

lookupChild in interface OlapElement

Overrides:

lookupChild in class DelegatingRolapMember

setContextIn

public void setContextIn(RolapEvaluator evaluator)

Pushes this calculated member or tuple onto the stack of evaluation contexts, and sets the context to the default member of the hierarchy.

Parameters:

evaluator - Evaluator

getSolveOrder

public int getSolveOrder()

Returns the solve order of this calculation. Identifies which order calculations are expanded.

Returns:

Solve order

getHierarchyOrdinal

public int getHierarchyOrdinal()

Returns the ordinal of this calculation; to resolve ties.

Returns:

Ordinal or calculation

isCalculatedInQuery

public boolean isCalculatedInQuery()

Returns whether this calculation is a member is computed from a WITH MEMBER clause in an MDX query.

Returns:

whether this calculation is computed in an MDX query

getCompiledExpression

public Calc getCompiledExpression(mondrian.rolap.RolapEvaluatorRoot root)

Returns the compiled expression to evaluate the scalar value of the current cell. This method will be called frequently, so the implementation should probably compile once and cache the result.

Parameters:

root - Root evaluation context

Returns:

Compiled scalar expression

containsAggregateFunction

public boolean containsAggregateFunction()

Returns whether this calculation contains an aggregate function.

Returns:

Whether this calculation contains an aggregate function.