mondrian.rolap
Class SubstitutingMemberReader

java.lang.Object
  mondrian.rolap.DelegatingMemberReader
      mondrian.rolap.SubstitutingMemberReader

All Implemented Interfaces:

MemberReader, MemberSource

public abstract class SubstitutingMemberReader
extends DelegatingMemberReader

Implementation of MemberReader which replaces given members with a substitute.

Derived classes must implement the DelegatingMemberReader.substitute(RolapMember) and DelegatingMemberReader.desubstitute(RolapMember) methods.

Since:

Oct 5, 2007

Author:

jhyde

Field Summary

Fields inherited from class mondrian.rolap.DelegatingMemberReader

memberReader

Constructor Summary

SubstitutingMemberReader(MemberReader memberReader)
Creates a SubstitutingMemberReader.

Method Summary

int	compare(RolapMember m1, RolapMember m2, boolean siblingsAreEqual) Compares two members according to their order in a prefix ordered traversal.
RolapMember	getDefaultMember()
RolapHierarchy	getHierarchy() Returns the hierarchy that this source is reading for.
RolapMember	getLeadMember(RolapMember member, int n) Returns the member n after member in the same level (or before, if n is negative).
TupleReader.MemberBuilder	getMemberBuilder()
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.
void	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 children parentMember to children.
void	getMemberChildren(RolapMember member, 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 between startMember and endMember into list.
List<RolapMember>	getMembers() Returns all members of this hierarchy, sorted by ordinal.
List<RolapMember>	getMembersInLevel(RolapLevel level, int startOrdinal, int endOrdinal) Returns all of the members in level whose ordinal lies between startOrdinal and endOrdinal.
List<RolapMember>	getMembersInLevel(RolapLevel level, int startOrdinal, int endOrdinal, TupleConstraint constraint) Returns the members in the given Level, optionally between a range of ordinals and applying a constraint.
List<RolapMember>	getRootMembers() Returns all members of this hierarchy which do not have a parent, sorted by ordinal.
RolapMember	lookupMember(List<Id.Segment> uniqueNameParts, boolean failIfNotFound) Finds a member based upon its unique name.
boolean	setCache(MemberCache cache) Sets the cache which this MemberSource will write to.

Methods inherited from class mondrian.rolap.DelegatingMemberReader

desubstitute, getLevelMemberCount, substitute

Methods inherited from class java.lang.Object

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

Constructor Detail

SubstitutingMemberReader

SubstitutingMemberReader(MemberReader memberReader)

Creates a SubstitutingMemberReader.

Parameters:

memberReader - Parent member reader

Method Detail

getLeadMember

public RolapMember getLeadMember(RolapMember member,
                                 int n)

Description copied from interface: MemberReader

Returns the member n after member in the same level (or before, if n is negative). Returns Hierarchy.getNullMember() if we run off the beginning or end of the level.

Specified by:

getLeadMember in interface MemberReader

Overrides:

getLeadMember in class DelegatingMemberReader

getMembersInLevel

public List<RolapMember> getMembersInLevel(RolapLevel level,
                                           int startOrdinal,
                                           int endOrdinal)

Description copied from interface: MemberReader

Returns all of the members in level whose ordinal lies between startOrdinal and endOrdinal.

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

Specified by:

getMembersInLevel in interface MemberReader

Overrides:

getMembersInLevel in class DelegatingMemberReader

Returns:

List of RolapMember

getMemberRange

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

Description copied from interface: MemberReader

Writes all members between startMember and endMember into list.

Specified by:

getMemberRange in interface MemberReader

Overrides:

getMemberRange in class DelegatingMemberReader

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. If siblingsAreEqual, then two members with the same parent will compare equal.

Specified by:

compare in interface MemberReader

Overrides:

compare in class DelegatingMemberReader

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

getHierarchy

public RolapHierarchy getHierarchy()

Description copied from interface: MemberSource

Returns the hierarchy that this source is reading for.

Specified by:

getHierarchy in interface MemberSource

Overrides:

getHierarchy in class DelegatingMemberReader

setCache

public boolean setCache(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) methods must write to the cache, in addition to returning members as a return value.

Specified by:

setCache in interface MemberSource

Overrides:

setCache in class DelegatingMemberReader

Parameters:

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

Returns:

Whether this MemberSource supports cache-writeback.

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

Overrides:

getMembers in class DelegatingMemberReader

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

Overrides:

getRootMembers in class DelegatingMemberReader

Returns:

List of RolapMembers

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

Overrides:

getMemberChildren in class DelegatingMemberReader

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

Overrides:

getMemberChildren in class DelegatingMemberReader

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

Overrides:

getMemberCount in class DelegatingMemberReader

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

Overrides:

lookupMember in class DelegatingMemberReader

getMemberChildren

public void getMemberChildren(RolapMember member,
                              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 interface MemberReader

Overrides:

getMemberChildren in class DelegatingMemberReader

Parameters:

member - Members whose children to find

children - List to populate with members

constraint - Constraint

getMemberChildren

public void 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 interface MemberReader

Overrides:

getMemberChildren in class DelegatingMemberReader

Parameters:

parentMembers - List of members whose children to find

children - List to populate with members

constraint - Constraint

getMembersInLevel

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

Description copied from interface: MemberReader

Returns the members in the given Level, optionally between a range of ordinals and applying a constraint.

Specified by:

getMembersInLevel in interface MemberReader

Overrides:

getMembersInLevel in class DelegatingMemberReader

Parameters:

level - Level

startOrdinal - Ordinal of first member to retrieve

endOrdinal - Ordinal of last member to upper bound

constraint - Constraint

Returns:

list of members

getDefaultMember

public RolapMember getDefaultMember()

Specified by:

getDefaultMember in interface MemberReader

Overrides:

getDefaultMember in class DelegatingMemberReader

getMemberParent

public RolapMember getMemberParent(RolapMember member)

Specified by:

getMemberParent in interface MemberReader

Overrides:

getMemberParent in class DelegatingMemberReader

getMemberBuilder

public TupleReader.MemberBuilder getMemberBuilder()

Specified by:

getMemberBuilder in interface MemberReader

Overrides:

getMemberBuilder in class DelegatingMemberReader