NoCacheMemberReader (Pentaho Community Edition Project: mondrian 9.2.0.0-288 API)

java.lang.Object
- mondrian.rolap.NoCacheMemberReader

Direct Known Subclasses:

RolapCubeHierarchy.NoCacheRolapCubeHierarchyMemberReader
```
public class NoCacheMemberReader
extends Object
```
NoCacheMemberReader implements MemberReader but without doing any kind of caching and avoiding to read all members.

Since:

06 October, 2007

Author:

jlopez, lcanals

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.
`List<RolapMember>`	`getChildrenFromCache(RolapMember member, MemberChildrenConstraint constraint)` Returns the children of `member` if they are currently in the cache, otherwise returns null.
`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.
`List<RolapMember>`	`getLevelMembersFromCache(RolapLevel level, TupleConstraint constraint)` Returns the members of `level` if they are currently in the cache, otherwise returns null.
`RolapMember`	`getMember(Object key)` Retrieves the `RolapMember` with a given key.
`RolapMember`	`getMember(Object key, boolean mustCheckCacheStatus)` Retrieves the `RolapMember` with a given key.
`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 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 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.
`boolean`	`isMutable()` Returns whether the cache supports removing selected items.
`RolapMember`	`lookupMember(List<Id.Segment> uniqueNameParts, boolean failIfNotFound)` Finds a member based upon its unique name.
`Object`	`makeKey(RolapMember parent, Object key)` Creates a key with which to `getMember(Object)` or `putMember(Object, RolapMember)` the `RolapMember` with a given parent and key.
`void`	`putChildren(RolapLevel level, TupleConstraint constraint, List<RolapMember> children)` Registers that the children of `level` are `children` (a list of `RolapMember`s).
`void`	`putChildren(RolapMember member, MemberChildrenConstraint constraint, List<RolapMember> children)` Registers that the children of `member` are `children` (a list of `RolapMember`s).
`Object`	`putMember(Object key, RolapMember value)` Replaces the `RolapMember` with a given key and returns the previous member if any.
`protected void`	`readMemberChildren(List<RolapMember> members, List<RolapMember> result, MemberChildrenConstraint constraint)` Reads the children of `member` into `result`.
`RolapMember`	`removeMember(Object key)` Removes the `RolapMember` with a given key from the cache.
`RolapMember`	`removeMemberAndDescendants(Object key)` Removes the designated `RolapMember` and all its descendants.
`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

- Method Detail
  - isMutable
```
public boolean isMutable()
```
    Returns whether the cache supports removing selected items. If it does, it is valid to call the removeMember(Object) and removeMemberAndDescendants(Object) methods.
    REVIEW: remove isMutable and move removeMember and removeMemberAndDescendants to new interface MutableMemberCache
    
    Returns:
    
    true if the cache supports removing selected items.
  - removeMember
```
public RolapMember removeMember(Object key)
```
    Removes the RolapMember with a given key from the cache. Returns the previous member with that key, or null. Optional operation: see isMutable().
    
    Parameters:
    
    key - cache key, created by makeKey(mondrian.rolap.RolapMember, java.lang.Object)
    
    Returns:
    
    previous member with that key, or null
  - removeMemberAndDescendants
```
public RolapMember removeMemberAndDescendants(Object key)
```
    Removes the designated RolapMember and all its descendants. Returns the previous member with that key, or null. Optional operation: see isMutable().
    
    Parameters:
    
    key - cache key, created by makeKey(mondrian.rolap.RolapMember, java.lang.Object)
    
    Returns:
    
    previous member with that key, or null
  - 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.
  - makeKey
```
public Object makeKey(RolapMember parent,
                      Object key)
```
    Creates a key with which to getMember(Object) or putMember(Object, RolapMember) the RolapMember with a given parent and key.
    
    Parameters:
    
    parent - Parent member
    
    key - Key of member within parent
    
    Returns:
    
    key with which to address this member in the cache
  - getMember
```
public RolapMember getMember(Object key)
```
    Retrieves the RolapMember with a given key.
    
    Parameters:
    
    key - cache key, created by makeKey(mondrian.rolap.RolapMember, java.lang.Object)
    
    Returns:
    
    member with a given cache key
  - getMember
```
public RolapMember getMember(Object key,
                             boolean mustCheckCacheStatus)
```
    Retrieves the RolapMember with a given key.
    
    Parameters:
    
    key - cache key, created by makeKey(mondrian.rolap.RolapMember, java.lang.Object)
    
    mustCheckCacheStatus - If true, do not check cache status
    
    Returns:
    
    member with a given cache key
  - putMember
```
public Object putMember(Object key,
                        RolapMember value)
```
    Replaces the RolapMember with a given key and returns the previous member if any.
    
    Parameters:
    
    key - cache key, created by makeKey(mondrian.rolap.RolapMember, java.lang.Object)
    
    value - new member
    
    Returns:
    
    Previous member with that key, 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.
  - 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
  - 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
  - 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
  - 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
  - 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 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.
    
    Parameters:
    
    parentMember - 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 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.
  - 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.
  - lookupMember
```
public RolapMember lookupMember(List<Id.Segment> uniqueNameParts,
                                boolean failIfNotFound)
```
    Description copied from interface: MemberSource
    
    Finds a member based upon its unique name.
  - getChildrenFromCache
```
public List<RolapMember> getChildrenFromCache(RolapMember member,
                                              MemberChildrenConstraint constraint)
```
    Returns the children of member if they are currently in the cache, otherwise returns null.
    The children may be garbage collected as soon as the returned list may be garbage collected.
    
    Parameters:
    
    member - the parent member
    
    constraint - the condition that was used when the members were fetched. May be null for all members (no constraint)
    
    Returns:
    
    list of children, or null if not in cache
  - getLevelMembersFromCache
```
public List<RolapMember> getLevelMembersFromCache(RolapLevel level,
                                                  TupleConstraint constraint)
```
    Returns the members of level if they are currently in the cache, otherwise returns null.
    The members may be garbage collected as soon as the returned list may be garbage collected.
    
    Parameters:
    
    level - the level whose members should be fetched
    
    constraint - the condition that was used when the members were fetched. May be null for all members (no constraint)
    
    Returns:
    
    members of level, or null if not in cache
  - putChildren
```
public void putChildren(RolapMember member,
                        MemberChildrenConstraint constraint,
                        List<RolapMember> children)
```
    Registers that the children of member are children (a list of RolapMembers).
    
    Parameters:
    
    member - the parent member
    
    constraint - the condition that was used when the members were fetched. May be null for all members (no constraint)
    
    children - list of children
  - putChildren
```
public void putChildren(RolapLevel level,
                        TupleConstraint constraint,
                        List<RolapMember> children)
```
    Registers that the children of level are children (a list of RolapMembers).
    
    Parameters:
    
    level - the parent level
    
    constraint - the condition that was used when the members were fetched. May be null for all members (no constraint)
    
    children - list of children
  - 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.
  - getMemberRange
```
public void getMemberRange(RolapLevel level,
                           RolapMember startMember,
                           RolapMember endMember,
                           List<RolapMember> list)
```
    Writes all members between startMember and endMember into list.
  - getMemberCount
```
public int getMemberCount()
```
    Description copied from interface: MemberSource
    
    Returns an estimate of number of members in this hierarchy.
  - 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
  - getMemberBuilder
```
public TupleReader.MemberBuilder getMemberBuilder()
```
  - getDefaultMember
```
public RolapMember getDefaultMember()
```
  - getLevelMemberCount
```
public int getLevelMemberCount(RolapLevel level)
```
    Returns the number of members in this level.
    
    Parameters:
    
    level - Level
    
    Returns:
    
    number of members in level
  - 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
  - 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
  - getMemberParent
```
public RolapMember getMemberParent(RolapMember member)
```
  - readMemberChildren
```
protected void readMemberChildren(List<RolapMember> members,
                                  List<RolapMember> result,
                                  MemberChildrenConstraint constraint)
```
    Reads the children of member 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)

Class NoCacheMemberReader

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isMutable

removeMember

removeMemberAndDescendants

getHierarchy

setCache

makeKey

getMember

getMember

putMember

getMembers

getRootMembers

getMembersInLevel

getMembersInLevel

getMemberByKey

getMemberChildren

getMemberChildren

getMemberChildren

getMemberChildren

lookupMember

getChildrenFromCache

getLevelMembersFromCache

putChildren

putChildren

getLeadMember

getMemberRange

getMemberCount

compare

getMemberBuilder

getDefaultMember

getLevelMemberCount

desubstitute

substitute

getMemberParent

readMemberChildren