Package mondrian.rolap

Class SmartMemberReader

java.lang.Object

mondrian.rolap.SmartMemberReader

All Implemented Interfaces:

MemberSource

Direct Known Subclasses:

RolapCubeHierarchy.CacheRolapCubeHierarchyMemberReader

public class SmartMemberReader
extends Object

SmartMemberReader implements MemberReader by keeping a cache of members and their children. If a member is 'in cache', there is a list of its children. It also caches the members of levels.

Synchronization: the MemberReader source must be called from synchronized(this) context - it does not synchronize itself (probably it should).

Constraints: Member.Children and Level.Members may be constrained by a SqlConstraint object. In this case a subset of all members is returned. These subsets are cached too and the SqlConstraint is part of the cache key. This is used in NON EMPTY context.

Uniqueness. We need to ensure that there is never more than one RolapMember object representing the same member.

Since:

21 December, 2001

Author:

jhyde

Field Summary

Fields

Modifier and Type	Field	Description
protected MemberCacheHelper	cacheHelper
protected List<RolapMember>	rootMembers
protected mondrian.rolap.MemberReader	source	access to source must be synchronized(this)

Method Summary

Modifier and Type	Method	Description
protected void	checkCacheStatus()
int	compare(RolapMember m1, RolapMember m2, boolean siblingsAreEqual)
int	countMemberChildren(Member member, List<RolapMember> children, MemberChildrenConstraint constraint)
RolapMember	desubstitute(RolapMember member)
RolapMember	getDefaultMember()
RolapHierarchy	getHierarchy()	Returns the hierarchy that this source is reading for.
RolapMember	getLeadMember(RolapMember member, int n)
int	getLevelMemberCount(RolapLevel level)
TupleReader.MemberBuilder	getMemberBuilder()
RolapMember	getMemberByKey(RolapLevel level, List<Comparable> keyValues)
mondrian.rolap.MemberCache	getMemberCache()
void	getMemberChildren(List<RolapMember> parentMembers, List<RolapMember> children)	Returns all members which are a child of one of the members in parentMembers, sorted by ordinal.
Map<? extends Member,Access>	getMemberChildren(List<RolapMember> parentMembers, List<RolapMember> children, MemberChildrenConstraint constraint)
void	getMemberChildren(RolapMember parentMember, List<RolapMember> children)	Writes all children parentMember to children.
Map<? extends Member,Access>	getMemberChildren(RolapMember parentMember, List<RolapMember> children, MemberChildrenConstraint constraint)
int	getMemberCount()	Returns an estimate of number of members in this hierarchy.
RolapMember	getMemberParent(RolapMember member)
void	getMemberRange(RolapLevel level, RolapMember startMember, RolapMember endMember, List<RolapMember> list)
List<RolapMember>	getMembers()	Returns all members of this hierarchy, sorted by ordinal.
List<RolapMember>	getMembersInLevel(RolapLevel level)
List<RolapMember>	getMembersInLevel(RolapLevel level, TupleConstraint constraint)
List<RolapMember>	getRootMembers()	Returns all members of this hierarchy which do not have a parent, sorted by ordinal.
boolean	isSorted(List<RolapMember> members)	Returns true if every element of members is not null and is strictly less than the following element; false otherwise.
RolapMember	lookupMember(List<Id.Segment> uniqueNameParts, boolean failIfNotFound)	Finds a member based upon its unique name.
protected void	readMemberChildren(List<RolapMember> members, List<RolapMember> result, MemberChildrenConstraint constraint)	Reads the children of member into cache, and also into result.
boolean	setCache(mondrian.rolap.MemberCache cache)	Sets the cache which this MemberSource will write to.
RolapMember	substitute(RolapMember member)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

source

protected final mondrian.rolap.MemberReader source

access to source must be synchronized(this)

cacheHelper

protected final MemberCacheHelper cacheHelper

rootMembers

protected List<RolapMember> rootMembers

Method Detail

getHierarchy

public RolapHierarchy getHierarchy()

Description copied from interface: MemberSource

Returns the hierarchy that this source is reading for.

Specified by:

getHierarchy in interface MemberSource

getMemberCache

public mondrian.rolap.MemberCache getMemberCache()

setCache

public boolean setCache(mondrian.rolap.MemberCache cache)

Description copied from interface: MemberSource

Sets the cache which this MemberSource will write to.

Cache-writeback is optional (for example, SqlMemberSource supports it, and ArrayMemberSource does not), and the return value from this method indicates whether this object supports it.

If this method returns true, the MemberSource.getMembers(), MemberSource.getRootMembers() and MemberSource.getMemberChildren(mondrian.rolap.RolapMember, java.util.List<mondrian.rolap.RolapMember>) methods must write to the cache, in addition to returning members as a return value.

Specified by:

setCache in interface MemberSource

Parameters:

cache - The MemberCache which the caller would like this MemberSource to write to.

Returns:

Whether this MemberSource supports cache-writeback.

substitute

public RolapMember substitute(RolapMember member)

desubstitute

public RolapMember desubstitute(RolapMember member)

getMemberByKey

public RolapMember getMemberByKey(RolapLevel level,
                                  List<Comparable> keyValues)

countMemberChildren

public int countMemberChildren(Member member,
                               List<RolapMember> children,
                               MemberChildrenConstraint constraint)

getMembers

public List<RolapMember> getMembers()

Description copied from interface: MemberSource

Returns all members of this hierarchy, sorted by ordinal.

If this object supports cache-writeaback, also writes these members to the cache.

Specified by:

getMembers in interface MemberSource

getRootMembers

public List<RolapMember> getRootMembers()

Description copied from interface: MemberSource

Returns all members of this hierarchy which do not have a parent, sorted by ordinal.

If this object supports cache-writeback, also writes these members to the cache.

Specified by:

getRootMembers in interface MemberSource

Returns:

List of RolapMembers

getMembersInLevel

public List<RolapMember> getMembersInLevel(RolapLevel level)

checkCacheStatus

protected void checkCacheStatus()

getMembersInLevel

public List<RolapMember> getMembersInLevel(RolapLevel level,
                                           TupleConstraint constraint)

getLevelMemberCount

public int getLevelMemberCount(RolapLevel level)

getMemberChildren

public void getMemberChildren(RolapMember parentMember,
                              List<RolapMember> children)

Description copied from interface: MemberSource

Writes all children parentMember to children.

If this object supports cache-writeback, also writes these members to the cache.

Specified by:

getMemberChildren in interface MemberSource

getMemberChildren

public Map<? extends Member,Access> getMemberChildren(RolapMember parentMember,
                                                            List<RolapMember> children,
                                                            MemberChildrenConstraint constraint)

getMemberChildren

public void getMemberChildren(List<RolapMember> parentMembers,
                              List<RolapMember> children)

Description copied from interface: MemberSource

Returns all members which are a child of one of the members in parentMembers, sorted by ordinal.

If this object supports cache-writeaback, also writes these members to the cache.

Specified by:

getMemberChildren in interface MemberSource

getMemberChildren

public Map<? extends Member,Access> getMemberChildren(List<RolapMember> parentMembers,
                                                            List<RolapMember> children,
                                                            MemberChildrenConstraint constraint)

lookupMember

public RolapMember lookupMember(List<Id.Segment> uniqueNameParts,
                                boolean failIfNotFound)

Description copied from interface: MemberSource

Finds a member based upon its unique name.

Specified by:

lookupMember in interface MemberSource

readMemberChildren

protected void readMemberChildren(List<RolapMember> members,
                                  List<RolapMember> result,
                                  MemberChildrenConstraint constraint)

Reads the children of member into cache, and also into result.

Parameters:

result - Children are written here, in order

members - Members whose children to read

constraint - restricts the returned members if possible (optional optimization)

isSorted

public boolean isSorted(List<RolapMember> members)

Returns true if every element of members is not null and is strictly less than the following element; false otherwise.

getLeadMember

public RolapMember getLeadMember(RolapMember member,
                                 int n)

getMemberRange

public void getMemberRange(RolapLevel level,
                           RolapMember startMember,
                           RolapMember endMember,
                           List<RolapMember> list)

getMemberCount

public int getMemberCount()

Description copied from interface: MemberSource

Returns an estimate of number of members in this hierarchy.

Specified by:

getMemberCount in interface MemberSource

compare

public int compare(RolapMember m1,
                   RolapMember m2,
                   boolean siblingsAreEqual)

getMemberBuilder

public TupleReader.MemberBuilder getMemberBuilder()

getDefaultMember

public RolapMember getDefaultMember()

getMemberParent

public RolapMember getMemberParent(RolapMember member)