Class SmartMemberReader
- java.lang.Object
-
- mondrian.rolap.SmartMemberReader
-
- All Implemented Interfaces:
MemberReader
,MemberSource
- Direct Known Subclasses:
RolapCubeHierarchy.CacheRolapCubeHierarchyMemberReader
public class SmartMemberReader extends Object implements MemberReader
SmartMemberReader
implementsMemberReader
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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) class
SmartMemberReader.SiblingIterator
SiblingIterator
helps traverse a hierarchy of members, by remembering the position at each level.
-
Field Summary
Fields Modifier and Type Field Description protected MemberCacheHelper
cacheHelper
protected List<RolapMember>
rootMembers
protected MemberReader
source
access tosource
must be synchronized(this)
-
Constructor Summary
Constructors Constructor Description SmartMemberReader(MemberReader source)
SmartMemberReader(MemberReader source, boolean cacheWriteback)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
checkCacheStatus()
int
compare(RolapMember m1, RolapMember m2, boolean siblingsAreEqual)
Compares two members according to their order in a prefix ordered traversal.RolapMember
desubstitute(RolapMember member)
Returns the member which was substituted.RolapMember
getDefaultMember()
RolapHierarchy
getHierarchy()
Returns the hierarchy that this source is reading for.RolapMember
getLeadMember(RolapMember member, int n)
Returns the membern
aftermember
in the same level (or before, ifn
is negative).int
getLevelMemberCount(RolapLevel level)
Returns the number of members in this level.TupleReader.MemberBuilder
getMemberBuilder()
RolapMember
getMemberByKey(RolapLevel level, List<Comparable> keyValues)
Looks up a member by its key value.MemberCache
getMemberCache()
void
getMemberChildren(List<RolapMember> parentMembers, List<RolapMember> children)
Returns all members which are a child of one of the members inparentMembers
, sorted by ordinal.Map<? extends Member,Access>
getMemberChildren(List<RolapMember> parentMembers, List<RolapMember> children, MemberChildrenConstraint constraint)
Populates a list of the children of a given set of Members, optionally applying a constraint.void
getMemberChildren(RolapMember parentMember, List<RolapMember> children)
Writes all childrenparentMember
tochildren
.Map<? extends Member,Access>
getMemberChildren(RolapMember parentMember, List<RolapMember> children, MemberChildrenConstraint constraint)
Populates a list of the children of a Member, optionally applying a 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)
Writes all members betweenstartMember
andendMember
intolist
.List<RolapMember>
getMembers()
Returns all members of this hierarchy, sorted by ordinal.List<RolapMember>
getMembersInLevel(RolapLevel level)
Returns all of the members inlevel
whose ordinal lies betweenstartOrdinal
andendOrdinal
.List<RolapMember>
getMembersInLevel(RolapLevel level, TupleConstraint constraint)
Returns the members in the given Level, optionally applying a 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 ofmembers
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 ofmember
into cache, and also intoresult
.boolean
setCache(MemberCache cache)
Sets the cache which thisMemberSource
will write to.RolapMember
substitute(RolapMember member)
Substitutes a given member.
-
-
-
Field Detail
-
source
protected final MemberReader source
access tosource
must be synchronized(this)
-
cacheHelper
protected final MemberCacheHelper cacheHelper
-
rootMembers
protected List<RolapMember> rootMembers
-
-
Constructor Detail
-
SmartMemberReader
SmartMemberReader(MemberReader source)
-
SmartMemberReader
SmartMemberReader(MemberReader source, boolean cacheWriteback)
-
-
Method Detail
-
getHierarchy
public RolapHierarchy getHierarchy()
Description copied from interface:MemberSource
Returns the hierarchy that this source is reading for.- Specified by:
getHierarchy
in interfaceMemberSource
-
getMemberCache
public MemberCache getMemberCache()
-
setCache
public boolean setCache(MemberCache cache)
Description copied from interface:MemberSource
Sets the cache which thisMemberSource
will write to.Cache-writeback is optional (for example,
SqlMemberSource
supports it, andArrayMemberSource
does not), and the return value from this method indicates whether this object supports it.If this method returns
true
, theMemberSource.getMembers()
,MemberSource.getRootMembers()
andMemberSource.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 interfaceMemberSource
- Parameters:
cache
- TheMemberCache
which the caller would like thisMemberSource
to write to.- Returns:
- Whether this
MemberSource
supports cache-writeback.
-
substitute
public RolapMember substitute(RolapMember member)
Description copied from interface:MemberReader
Substitutes a given member. If member is null, returns null.This method is called whenever a member is returned from the wrapped member reader and is to be returned to the caller. You could say that it translates 'to caller space'.
- Specified by:
substitute
in interfaceMemberReader
- Parameters:
member
- Member- Returns:
- Substitute member
-
desubstitute
public RolapMember desubstitute(RolapMember member)
Description copied from interface:MemberReader
Returns the member which was substituted. If member is null, returns null.This method is called whenever the caller passes a member into a method and needs to be passed to a method on the wrapped member reader. You could say that it translates 'from caller space'.
- Specified by:
desubstitute
in interfaceMemberReader
- Parameters:
member
- Member- Returns:
- Internal member
-
getMemberByKey
public RolapMember getMemberByKey(RolapLevel level, List<Comparable> keyValues)
Description copied from interface:MemberReader
Looks up a member by its key value.- Specified by:
getMemberByKey
in interfaceMemberReader
- Parameters:
level
- LevelkeyValues
- Key values- Returns:
- Member, or null
-
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 interfaceMemberSource
-
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 interfaceMemberSource
- Returns:
List
ofRolapMember
s
-
getMembersInLevel
public List<RolapMember> getMembersInLevel(RolapLevel level)
Description copied from interface:MemberReader
Returns all of the members inlevel
whose ordinal lies betweenstartOrdinal
andendOrdinal
.If this object
supports cache-writeback
, also writes these members to the cache.- Specified by:
getMembersInLevel
in interfaceMemberReader
- Returns:
List
ofRolapMember
-
checkCacheStatus
protected void checkCacheStatus()
-
getMembersInLevel
public List<RolapMember> getMembersInLevel(RolapLevel level, TupleConstraint constraint)
Description copied from interface:MemberReader
Returns the members in the given Level, optionally applying a constraint.- Specified by:
getMembersInLevel
in interfaceMemberReader
- Parameters:
level
- Levelconstraint
- Constraint- Returns:
- list of members
-
getLevelMemberCount
public int getLevelMemberCount(RolapLevel level)
Description copied from interface:MemberReader
Returns the number of members in this level.- Specified by:
getLevelMemberCount
in interfaceMemberReader
- Parameters:
level
- Level- Returns:
- number of members in level
-
getMemberChildren
public void getMemberChildren(RolapMember parentMember, List<RolapMember> children)
Description copied from interface:MemberSource
Writes all childrenparentMember
tochildren
.If this object
supports cache-writeback
, also writes these members to the cache.- Specified by:
getMemberChildren
in interfaceMemberSource
-
getMemberChildren
public Map<? extends Member,Access> getMemberChildren(RolapMember parentMember, List<RolapMember> children, MemberChildrenConstraint constraint)
Description copied from interface:MemberReader
Populates a list of the children of a Member, optionally applying a constraint.- Specified by:
getMemberChildren
in interfaceMemberReader
- Parameters:
parentMember
- Members whose children to findchildren
- List to populate with membersconstraint
- Constraint- Returns:
- After populating the list passed as an argument,
this method returns a map of the members it just populated
along with the Access information applicable. If no access
control applies to the member, the map will contain
null
values.
-
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 inparentMembers
, sorted by ordinal.If this object
supports cache-writeaback
, also writes these members to the cache.- Specified by:
getMemberChildren
in interfaceMemberSource
-
getMemberChildren
public Map<? extends Member,Access> getMemberChildren(List<RolapMember> parentMembers, List<RolapMember> children, MemberChildrenConstraint constraint)
Description copied from interface:MemberReader
Populates a list of the children of a given set of Members, optionally applying a constraint.- Specified by:
getMemberChildren
in interfaceMemberReader
- Parameters:
parentMembers
- List of members whose children to findchildren
- List to populate with membersconstraint
- Constraint- Returns:
- After populating the list passed as an argument,
this method returns a map of the members it just populated
along with the Access information applicable. If no access
control applies to the member, the map will contain
null
values.
-
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 interfaceMemberSource
-
readMemberChildren
protected void readMemberChildren(List<RolapMember> members, List<RolapMember> result, MemberChildrenConstraint constraint)
Reads the children ofmember
into cache, and also intoresult
.- Parameters:
result
- Children are written here, in ordermembers
- Members whose children to readconstraint
- restricts the returned members if possible (optional optimization)
-
isSorted
public boolean isSorted(List<RolapMember> members)
Returns true if every element ofmembers
is not null and is strictly less than the following element; false otherwise.
-
getLeadMember
public RolapMember getLeadMember(RolapMember member, int n)
Description copied from interface:MemberReader
Returns the membern
aftermember
in the same level (or before, ifn
is negative). ReturnsHierarchy.getNullMember()
if we run off the beginning or end of the level.- Specified by:
getLeadMember
in interfaceMemberReader
-
getMemberRange
public void getMemberRange(RolapLevel level, RolapMember startMember, RolapMember endMember, List<RolapMember> list)
Description copied from interface:MemberReader
Writes all members betweenstartMember
andendMember
intolist
.- Specified by:
getMemberRange
in interfaceMemberReader
-
getMemberCount
public int getMemberCount()
Description copied from interface:MemberSource
Returns an estimate of number of members in this hierarchy.- Specified by:
getMemberCount
in interfaceMemberSource
-
compare
public int compare(RolapMember m1, RolapMember m2, boolean siblingsAreEqual)
Description copied from interface:MemberReader
Compares two members according to their order in a prefix ordered traversal. IfsiblingsAreEqual
, then two members with the same parent will compare equal.- Specified by:
compare
in interfaceMemberReader
- Returns:
- less than zero if m1 occurs before m2,
greater than zero if m1 occurs after m2,
zero if m1 is equal to m2, or if
siblingsAreEqual
and m1 and m2 have the same parent
-
getMemberBuilder
public TupleReader.MemberBuilder getMemberBuilder()
- Specified by:
getMemberBuilder
in interfaceMemberReader
-
getDefaultMember
public RolapMember getDefaultMember()
- Specified by:
getDefaultMember
in interfaceMemberReader
-
getMemberParent
public RolapMember getMemberParent(RolapMember member)
- Specified by:
getMemberParent
in interfaceMemberReader
-
-