mondrian.rolap

Interface RolapMemberInCube

All Superinterfaces:

Annotated, Comparable, Member, OlapElement, RolapMember

All Known Implementing Classes:

RolapCubeMember, RolapHierarchy.LimitedRollupMember

public interface RolapMemberInCube
extends RolapMember

Extension to RolapMember that knows the current cube.

This is typical of members that occur in queries (where there is always a current cube) as opposed to members that belong to caches. Members of shared dimensions might occur in several different cubes, or even several times in the same virtual cube.

Since:

20 March, 2010

Author:

jhyde

Nested Class Summary

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

Member.MemberType

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

OlapElement.LocalizedProperty

Method Summary

Modifier and Type	Method and Description
boolean	containsAggregateFunction() Returns whether this calculation contains an aggregate function.
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.
int	getHierarchyOrdinal() Returns the ordinal of this calculation; to resolve ties.
int	getSolveOrder() Returns the solve order of this calculation.
boolean	isCalculatedInQuery() Returns whether this calculation is a member is computed from a WITH MEMBER clause in an MDX query.
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.

Methods inherited from interface mondrian.rolap.RolapMember

getHierarchy, getKey, getLevel, getParentMember, isAllMember

Methods inherited from interface mondrian.olap.Member

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

Methods inherited from interface mondrian.olap.OlapElement

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface mondrian.olap.Annotated

getAnnotationMap

Method Detail

getCube

RolapCube getCube()

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.

Returns:

Cube this cube member belongs to, never null

setContextIn

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

int getSolveOrder()

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

Returns:

Solve order

getHierarchyOrdinal

int getHierarchyOrdinal()

Returns the ordinal of this calculation; to resolve ties.

Returns:

Ordinal or calculation

isCalculatedInQuery

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

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

boolean containsAggregateFunction()

Returns whether this calculation contains an aggregate function.

Returns:

Whether this calculation contains an aggregate function.