SubstitutingMemberReader (Pentaho Community Edition Project: mondrian 8.0.0.0-6 API)

java.lang.Object
- mondrian.rolap.SubstitutingMemberReader

```
public abstract class SubstitutingMemberReader
extends Object
```
Implementation of MemberReader which replaces given members with a substitute.
Derived classes must implement the substitute(RolapMember) and desubstitute(RolapMember) methods.

Since:

Oct 5, 2007

Author:

jhyde

Field Summary

Fields
Modifier and Type Field and Description

protected mondrian.rolap.MemberReader memberReader

Fields
Modifier and Type	Field and Description
`protected mondrian.rolap.MemberReader`	`memberReader`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 member `n` after `member` in the same level (or before, if `n` 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.
`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)` 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`.
`Map<? extends Member,Access>`	`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)` Returns all of the members in `level` whose ordinal lies between `startOrdinal` and `endOrdinal`.
`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.
`RolapMember`	`lookupMember(List<Id.Segment> uniqueNameParts, boolean failIfNotFound)` Finds a member based upon its unique name.
`boolean`	`setCache(mondrian.rolap.MemberCache cache)` Sets the cache which this `MemberSource` will write to.
`RolapMember`	`substitute(RolapMember member)` Substitutes a given member.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - memberReader
```
protected final mondrian.rolap.MemberReader memberReader
```
- Method Detail
  - getLeadMember
```
public RolapMember getLeadMember(RolapMember member,
                                 int n)
```
    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.
  - getMembersInLevel
```
public List<RolapMember> getMembersInLevel(RolapLevel level)
```
    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.
    
    Returns:
    
    List of RolapMember
  - getMemberRange
```
public void getMemberRange(RolapLevel level,
                           RolapMember startMember,
                           RolapMember endMember,
                           List<RolapMember> list)
```
    Writes all members between startMember and endMember into list.
  - compare
```
public int compare(RolapMember m1,
                   RolapMember m2,
                   boolean siblingsAreEqual)
```
    Compares two members according to their order in a prefix ordered traversal. If siblingsAreEqual, then two members with the same parent will compare equal.
    
    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.
  - 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.
    
    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.
  - 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.
    
    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.
  - 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.
  - getMemberCount
```
public int getMemberCount()
```
    Description copied from interface: MemberSource
    
    Returns an estimate of number of members in this hierarchy.
  - lookupMember
```
public RolapMember lookupMember(List<Id.Segment> uniqueNameParts,
                                boolean failIfNotFound)
```
    Description copied from interface: MemberSource
    
    Finds a member based upon its unique name.
  - getMemberChildren
```
public Map<? extends Member,Access> getMemberChildren(RolapMember member,
                                                      List<RolapMember> children,
                                                      MemberChildrenConstraint constraint)
```
    Populates a list of the children of a Member, optionally applying a constraint.
    
    Parameters:
    
    member - Members whose children to find
    
    children - List to populate with members
    
    constraint - 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 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.
    
    Parameters:
    
    parentMembers - List of members whose children to find
    
    children - List to populate with members
    
    constraint - 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.
  - getMembersInLevel
```
public List<RolapMember> getMembersInLevel(RolapLevel level,
                                           TupleConstraint constraint)
```
    Returns the members in the given Level, optionally applying a constraint.
    
    Parameters:
    
    level - Level
    
    constraint - Constraint
    
    Returns:
    
    list of members
  - getDefaultMember
```
public RolapMember getDefaultMember()
```
  - getMemberParent
```
public RolapMember getMemberParent(RolapMember member)
```
  - getMemberBuilder
```
public TupleReader.MemberBuilder getMemberBuilder()
```
  - substitute
```
public RolapMember substitute(RolapMember member)
```
    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'.
    
    Parameters:
    
    member - Member
    
    Returns:
    
    Substitute member
  - desubstitute
```
public RolapMember desubstitute(RolapMember member)
```
    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'.
    
    Parameters:
    
    member - Member
    
    Returns:
    
    Internal member
  - getMemberByKey
```
public RolapMember getMemberByKey(RolapLevel level,
                                  List<Comparable> keyValues)
```
    Looks up a member by its key value.
    
    Parameters:
    
    level - Level
    
    keyValues - Key values
    
    Returns:
    
    Member, or null
  - getLevelMemberCount
```
public int getLevelMemberCount(RolapLevel level)
```
    Returns the number of members in this level.
    
    Parameters:
    
    level - Level
    
    Returns:
    
    number of members in level

Class SubstitutingMemberReader

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

memberReader

Method Detail

getLeadMember

getMembersInLevel

getMemberRange

compare

getHierarchy

setCache

getMembers

getRootMembers

getMemberChildren

getMemberChildren

getMemberCount

lookupMember

getMemberChildren

getMemberChildren

getMembersInLevel

getDefaultMember

getMemberParent

getMemberBuilder

substitute

desubstitute

getMemberByKey

getLevelMemberCount