mondrian.rolap

Class RolapCubeHierarchy

java.lang.Object

mondrian.olap.OlapElementBase

mondrian.olap.HierarchyBase

mondrian.rolap.RolapHierarchy

mondrian.rolap.RolapCubeHierarchy

All Implemented Interfaces:

Annotated, Hierarchy, OlapElement

public class RolapCubeHierarchy
extends RolapHierarchy

Hierarchy that is associated with a specific Cube.

Author:

Will Gorman, 19 October 2007

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RolapCubeHierarchy.CacheRolapCubeHierarchyMemberReader member reader wrapper - uses existing member reader, but wraps and caches all intermediate members.
class	RolapCubeHierarchy.NoCacheRolapCubeHierarchyMemberReader Same as RolapCubeHierarchy.RolapCubeHierarchyMemberReader but without caching anything.
static interface	RolapCubeHierarchy.RolapCubeHierarchyMemberReader TODO: Since this is part of a caching strategy, should be implemented as a Strategy Pattern, avoiding hierarchy.
static class	RolapCubeHierarchy.RolapCubeSqlMemberSource

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

RolapHierarchy.LimitedRollupMember, RolapHierarchy.RolapCalculatedMeasure, RolapHierarchy.RolapNullMember

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

OlapElement.LocalizedProperty

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	usingCubeFact True if the hierarchy is degenerate - has no dimension table of its own, just drives from the cube's fact table.

Fields inherited from class mondrian.rolap.RolapHierarchy

closureFor, nullLevel, relation, xmlHierarchy

Fields inherited from class mondrian.olap.HierarchyBase

allLevelName, allMemberName, description, dimension, hasAll, levels, name, subName, uniqueName

Fields inherited from class mondrian.olap.OlapElementBase

caption, visible

Constructor Summary

Constructors

Constructor and Description
RolapCubeHierarchy(RolapCubeDimension cubeDimension, MondrianDef.CubeDimension cubeDim, RolapHierarchy rolapHierarchy, String subName, int ordinal) Creates a RolapCubeHierarchy.

Method Summary

Modifier and Type	Method and Description
protected int	computeHashCode() Computes this object's hash code.
(package private) String	convertMemberName(String memberUniqueName) Converts the unique name of a member of the underlying hierarchy to the appropriate name for this hierarchy.
Member	createMember(Member parent, Level level, String name, Formula formula) Creates a member of this hierarchy.
boolean	equals(Object o)
protected void	extractNewAliases(MondrianDef.RelationOrJoin oldrel, MondrianDef.RelationOrJoin newrel) Populates the alias map for the old and new relations.
String	getAllLevelName() Returns the name of the 'all' level in this hierarchy.
RolapCubeMember	getAllMember() Returns the 'all' member.
String	getAllMemberName()
RolapCube	getCube()
RolapCubeMember	getDefaultMember() Returns the default member of this hierarchy.
RolapCubeLevel[]	getLevels() Returns the levels in this hierarchy.
(package private) MemberReader	getMemberReader()
Member	getNullMember() Returns a special member representing the "null" value.
int	getOrdinalInCube() Returns the ordinal of this hierarchy in its cube.
MondrianDef.RelationOrJoin	getRelation() The currentRelation object is derived from the shared relation object it is generated via the RolapStar object, and contains unique aliases for it's particular join path
RolapHierarchy	getRolapHierarchy()
String	getSharedHierarchyName() Returns the name of the source hierarchy, if this hierarchy is shared, otherwise null.
(package private) void	init(MondrianDef.CubeDimension xmlDimension) Initializes a hierarchy within the context of a cube.
boolean	isUsingCubeFact()
String	lookupAlias(String origTable)
void	setDefaultMember(Member defaultMeasure) Sets default member of this Hierarchy.
(package private) void	setMemberReader(MemberReader memberReader)
(package private) boolean	tableExists(String tableName)

Methods inherited from class mondrian.rolap.RolapHierarchy

addToFrom, addToFrom, addToFromInverse, createAnnotationMap, createClosedPeerDimension, createMemberReader, getAggregateChildrenExpression, getAlias, getAnnotationMap, getLogger, getLowestMembersForAccess, getRolapSchema, getTable, getUniqueKeyLevelName, getUniqueTable, getXmlHierarchy, isRagged, newMeasuresLevel

Methods inherited from class mondrian.olap.HierarchyBase

equals, getDescription, getDimension, getHierarchy, getName, getQualifiedName, getSubName, getUniqueName, getUniqueNameSsas, hasAll, lookupChild

Methods inherited from class mondrian.olap.OlapElementBase

clone, getCaption, getLocalized, hashCode, isVisible, setCaption, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface mondrian.olap.OlapElement

getCaption, getLocalized, isVisible

Field Detail

usingCubeFact

protected final boolean usingCubeFact

True if the hierarchy is degenerate - has no dimension table of its own, just drives from the cube's fact table.

Constructor Detail

RolapCubeHierarchy

public RolapCubeHierarchy(RolapCubeDimension cubeDimension,
                          MondrianDef.CubeDimension cubeDim,
                          RolapHierarchy rolapHierarchy,
                          String subName,
                          int ordinal)

Creates a RolapCubeHierarchy.

Parameters:

cubeDimension - Dimension

cubeDim - XML dimension element

rolapHierarchy - Wrapped hierarchy

subName - Name of hierarchy within dimension

ordinal - Ordinal of hierarchy within cube

Method Detail

getLevels

public RolapCubeLevel[] getLevels()

Description copied from interface: Hierarchy

Returns the levels in this hierarchy.

If a hierarchy is subject to access-control, some of the levels may not be visible; use SchemaReader.getHierarchyLevels(mondrian.olap.Hierarchy) instead.

Specified by:

getLevels in interface Hierarchy

Overrides:

getLevels in class HierarchyBase

getAllMemberName

public String getAllMemberName()

Overrides:

getAllMemberName in class HierarchyBase

getSharedHierarchyName

public String getSharedHierarchyName()

Description copied from class: RolapHierarchy

Returns the name of the source hierarchy, if this hierarchy is shared, otherwise null.

If this hierarchy is a public -- that is, it belongs to a dimension which is a usage of a shared dimension -- then sharedHierarchyName holds the unique name of the shared hierarchy; otherwise it is null.

Suppose this hierarchy is "Weekly" in the dimension "Order Date" of cube "Sales", and that "Order Date" is a usage of the "Time" dimension. Then sharedHierarchyName will be "[Time].[Weekly]".

Overrides:

getSharedHierarchyName in class RolapHierarchy

getAllLevelName

public String getAllLevelName()

Description copied from class: HierarchyBase

Returns the name of the 'all' level in this hierarchy.

Overrides:

getAllLevelName in class HierarchyBase

Returns:

name of the 'all' level

isUsingCubeFact

public boolean isUsingCubeFact()

lookupAlias

public String lookupAlias(String origTable)

getRolapHierarchy

public final RolapHierarchy getRolapHierarchy()

getOrdinalInCube

public final int getOrdinalInCube()

Description copied from class: RolapHierarchy

Returns the ordinal of this hierarchy in its cube.

Temporarily defined against RolapHierarchy; will be moved to RolapCubeHierarchy as soon as the measures hierarchy is a RolapCubeHierarchy.

Overrides:

getOrdinalInCube in class RolapHierarchy

Returns:

Ordinal of this hierarchy in its cube

extractNewAliases

protected void extractNewAliases(MondrianDef.RelationOrJoin oldrel,
                                 MondrianDef.RelationOrJoin newrel)

Populates the alias map for the old and new relations.

This method may be simplified when we obsolete HierarchyUsage.

Parameters:

oldrel - Original relation, as defined in the schema

newrel - New star relation, generated by RolapStar, canonical, and shared between all cubes with similar structure

equals

public boolean equals(Object o)

Overrides:

equals in class RolapHierarchy

computeHashCode

protected int computeHashCode()

Description copied from class: OlapElementBase

Computes this object's hash code. Called at most once.

Overrides:

computeHashCode in class RolapHierarchy

Returns:

hash code

createMember

public Member createMember(Member parent,
                           Level level,
                           String name,
                           Formula formula)

Description copied from interface: Hierarchy

Creates a member of this hierarchy. If this is the measures hierarchy, a calculated member is created, and formula must not be null.

Specified by:

createMember in interface Hierarchy

Overrides:

createMember in class RolapHierarchy

tableExists

boolean tableExists(String tableName)

Overrides:

tableExists in class RolapHierarchy

getRelation

public MondrianDef.RelationOrJoin getRelation()

The currentRelation object is derived from the shared relation object it is generated via the RolapStar object, and contains unique aliases for it's particular join path

Overrides:

getRelation in class RolapHierarchy

Returns:

rolap cube hierarchy relation

getDefaultMember

public final RolapCubeMember getDefaultMember()

Description copied from interface: Hierarchy

Returns the default member of this hierarchy.

If a hierarchy is subject to access-control, the default member may not be visible, so use SchemaReader.getHierarchyDefaultMember(mondrian.olap.Hierarchy).

Specified by:

getDefaultMember in interface Hierarchy

Overrides:

getDefaultMember in class RolapHierarchy

getNullMember

public Member getNullMember()

Description copied from interface: Hierarchy

Returns a special member representing the "null" value. This never occurs on an axis, but may occur if functions such as Lead, NextMember and ParentMember walk off the end of the hierarchy.

Specified by:

getNullMember in interface Hierarchy

Overrides:

getNullMember in class RolapHierarchy

getAllMember

public RolapCubeMember getAllMember()

Returns the 'all' member.

Specified by:

getAllMember in interface Hierarchy

Overrides:

getAllMember in class RolapHierarchy

setMemberReader

void setMemberReader(MemberReader memberReader)

Overrides:

setMemberReader in class RolapHierarchy

getMemberReader

MemberReader getMemberReader()

Overrides:

getMemberReader in class RolapHierarchy

setDefaultMember

public void setDefaultMember(Member defaultMeasure)

Description copied from class: RolapHierarchy

Sets default member of this Hierarchy.

Overrides:

setDefaultMember in class RolapHierarchy

Parameters:

defaultMeasure - Default member

init

void init(MondrianDef.CubeDimension xmlDimension)

Description copied from class: RolapHierarchy

Initializes a hierarchy within the context of a cube.

Overrides:

init in class RolapHierarchy

convertMemberName

final String convertMemberName(String memberUniqueName)

Converts the unique name of a member of the underlying hierarchy to the appropriate name for this hierarchy.

For example, if the shared hierarchy is [Time].[Quarterly] and the hierarchy usage is [Ship Time].[Quarterly], then [Time].[1997].[Q1] would be translated to [Ship Time].[Quarerly].[1997].[Q1].

Parameters:

memberUniqueName - Unique name of member from underlying hierarchy

Returns:

Translated unique name

getCube

public final RolapCube getCube()