Package mondrian.rolap

Interface RolapMember

All Superinterfaces:

Annotated, Comparable, Member, OlapElement

All Known Subinterfaces:

RolapMemberInCube

All Known Implementing Classes:

DelegatingRolapMember, RolapBaseCubeMeasure, RolapCalculatedMember, RolapCubeMember, RolapHierarchy.LimitedRollupMember, RolapHierarchy.RolapCalculatedMeasure, RolapMemberBase, RolapResult.CompoundSlicerRolapMember, RolapVirtualCubeMeasure, VisualTotalsFunDef.VisualTotalMember

public interface RolapMember
extends Member

A RolapMember is a member of a RolapHierarchy. There are sub-classes for RolapStoredMeasure, RolapCalculatedMember.

Since:

10 August, 2001

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	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.
RolapHierarchy	getHierarchy()
int	getHierarchyOrdinal()	Returns the ordinal of this calculation; to resolve ties.
Object	getKey()
RolapLevel	getLevel()
RolapMember	getParentMember()	Returns this member's parent, or null (not the 'null member', as returned by Hierarchy.getNullMember()) if it has no parent.
int	getSolveOrder()	Returns the solve order of this calculation.
boolean	isAllMember()	Deprecated. will be removed in mondrian-4.0
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.olap.Annotated

getAnnotationMap

Methods inherited from interface java.lang.Comparable

compareTo

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, isOnSameHierarchyChain, isParentChildLeaf, isParentChildPhysicalMember, setName, setProperty

Methods inherited from interface mondrian.olap.OlapElement

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

Method Details

getKey

Object getKey()

getParentMember

RolapMember 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

getHierarchy

RolapHierarchy getHierarchy()

Specified by:

getHierarchy in interface Member

Specified by:

getHierarchy in interface OlapElement

getLevel

RolapLevel getLevel()

Specified by:

getLevel in interface Member

isAllMember

boolean isAllMember()

Deprecated.

will be removed in mondrian-4.0

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.