SqlMemberSource (Mondrian OLAP Engine, version 3.13.0.0-25)

java.lang.Object
- mondrian.rolap.SqlMemberSource

All Implemented Interfaces:

MemberReader, MemberSource, TupleReader.MemberBuilder

Direct Known Subclasses:

RolapCubeHierarchy.RolapCubeSqlMemberSource
```
class SqlMemberSource
extends Object
implements MemberReader, TupleReader.MemberBuilder
```
A SqlMemberSource reads members from a SQL database.
It's a good idea to put a CacheMemberReader on top of this.

Since:

21 December, 2001

Author:

jhyde

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SqlMemberSource.NullValuePoolFactory` Default `SqlMemberSource.ValuePoolFactory` implementation, used if `MondrianProperties.SqlMemberSourceValuePoolFactoryClass` is not set.
`static interface`	`SqlMemberSource.ValuePoolFactory` Interface definition for the pluggable factory used to decide which implementation of `Map` to use to pool reusable values.
`static class`	`SqlMemberSource.ValuePoolFactoryFactory` Creates the ValuePoolFactory which is in turn used to create property-value maps for member properties.

Constructor Summary

Constructors
Constructor and Description

SqlMemberSource(RolapHierarchy hierarchy)

Constructors
Constructor and Description
`SqlMemberSource(RolapHierarchy hierarchy)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RolapMember`	`allMember()` Returns the 'all' member of the hierarchy.
`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.
`MemberCache`	`getMemberCache()` Returns the `MemberCache` to look up members before creating them.
`Object`	`getMemberCacheLock()` Returns the object which acts as the member cache synchronization lock.
`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 mcc)` 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> memberList)` 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.
`static boolean`	`isLevelCollapsed(AggStar aggStar, RolapCubeLevel level)` Determine if the given aggregate table has the dimension level specified within in (AggStar.FactTable) it, aka collapsed, or associated with foreign keys (AggStar.DimTable)
`static boolean`	`levelContainsMultipleColumns(RolapLevel level)` Determine if a level contains more than a single column for its data, such as an ordinal column or property column
`RolapMember`	`lookupMember(List<Id.Segment> uniqueNameParts, boolean failIfNotFound)` Finds a member based upon its unique name.
`(package private) Pair<String,List<SqlStatement.Type>>`	`makeChildMemberSql(RolapMember member, DataSource dataSource, MemberChildrenConstraint constraint)` Generates the SQL statement to access the children of `member`.
`RolapMember`	`makeMember(RolapMember parentMember, RolapLevel childLevel, Object value, Object captionValue, boolean parentChild, SqlStatement stmt, Object key, int columnOffset)` Creates a new member (together with its properties).
`boolean`	`setCache(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

- Constructor Detail
  - SqlMemberSource
```
SqlMemberSource(RolapHierarchy hierarchy)
```
- 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
  - 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<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.
  - 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
  - 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 interface MemberReader
    
    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 interface MemberReader
    
    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 interface MemberReader
    
    Parameters:
    
    level - Level
    
    keyValues - Key values
    
    Returns:
    
    Member, or null
  - 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
  - getLevelMemberCount
```
public int getLevelMemberCount(RolapLevel level)
```
    Description copied from interface: MemberReader
    
    Returns the number of members in this level.
    
    Specified by:
    
    getLevelMemberCount in interface MemberReader
    
    Parameters:
    
    level - Level
    
    Returns:
    
    number of members in level
  - 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
  - getMembersInLevel
```
public List<RolapMember> getMembersInLevel(RolapLevel level)
```
    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
    
    Returns:
    
    List of RolapMember
  - 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 interface MemberReader
    
    Parameters:
    
    level - Level
    
    constraint - Constraint
    
    Returns:
    
    list of members
  - getMemberCache
```
public MemberCache getMemberCache()
```
    Description copied from interface: TupleReader.MemberBuilder
    
    Returns the MemberCache to look up members before creating them.
    
    Specified by:
    
    getMemberCache in interface TupleReader.MemberBuilder
    
    Returns:
    
    member cache
  - getMemberCacheLock
```
public Object getMemberCacheLock()
```
    Description copied from interface: TupleReader.MemberBuilder
    
    Returns the object which acts as the member cache synchronization lock.
    
    Specified by:
    
    getMemberCacheLock in interface TupleReader.MemberBuilder
    
    Returns:
    
    Object to lock
  - 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
  - makeChildMemberSql
```
Pair<String,List<SqlStatement.Type>> makeChildMemberSql(RolapMember member,
                                                        DataSource dataSource,
                                                        MemberChildrenConstraint constraint)
```
    Generates the SQL statement to access the children of member. For example,
    SELECT "city" FROM "customer" WHERE "country" = 'USA' AND "state_province" = 'BC' GROUP BY "city"
    retrieves the children of the member [Canada].[BC].
    Note that this method is never called in the context of virtual cubes, it is only called on regular cubes.
    See also SqlTupleReader.makeLevelMembersSql(javax.sql.DataSource, java.util.List<mondrian.rolap.TargetBase>).
  - levelContainsMultipleColumns
```
public static boolean levelContainsMultipleColumns(RolapLevel level)
```
    Determine if a level contains more than a single column for its data, such as an ordinal column or property column
    
    Parameters:
    
    level - the level to check
    
    Returns:
    
    true if multiple relational columns are involved in this level
  - isLevelCollapsed
```
public static boolean isLevelCollapsed(AggStar aggStar,
                                       RolapCubeLevel level)
```
    Determine if the given aggregate table has the dimension level specified within in (AggStar.FactTable) it, aka collapsed, or associated with foreign keys (AggStar.DimTable)
    
    Parameters:
    
    aggStar - aggregate star if exists
    
    level - level
    
    Returns:
    
    true if agg table has level or not
  - 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 mcc)
```
    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
    
    Parameters:
    
    parentMembers - List of members whose children to find
    
    children - List to populate with members
    
    mcc - 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(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)
```
    Description copied from interface: MemberReader
    
    Populates a list of the children of a Member, optionally applying a constraint.
    
    Specified by:
    
    getMemberChildren in interface MemberReader
    
    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.
  - makeMember
```
public RolapMember makeMember(RolapMember parentMember,
                              RolapLevel childLevel,
                              Object value,
                              Object captionValue,
                              boolean parentChild,
                              SqlStatement stmt,
                              Object key,
                              int columnOffset)
                       throws SQLException
```
    Description copied from interface: TupleReader.MemberBuilder
    
    Creates a new member (together with its properties).
    
    Specified by:
    
    makeMember in interface TupleReader.MemberBuilder
    
    Parameters:
    
    parentMember - Parent member
    
    childLevel - Child level
    
    value - Member value
    
    captionValue - Caption
    
    parentChild - Whether a parent-child hierarchy
    
    stmt - SQL statement
    
    key - Member key
    
    columnOffset - Column ordinal (0-based)
    
    Returns:
    
    new member
    
    Throws:
    
    SQLException - on error
  - allMember
```
public RolapMember allMember()
```
    Description copied from interface: TupleReader.MemberBuilder
    
    Returns the 'all' member of the hierarchy.
    
    Specified by:
    
    allMember in interface TupleReader.MemberBuilder
    
    Returns:
    
    The 'all' member
  - 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
  - getMemberRange
```
public void getMemberRange(RolapLevel level,
                           RolapMember startMember,
                           RolapMember endMember,
                           List<RolapMember> memberList)
```
    Description copied from interface: MemberReader
    
    Writes all members between startMember and endMember into list.
    
    Specified by:
    
    getMemberRange in interface MemberReader
  - 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
    
    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 interface MemberReader
  - getDefaultMember
```
public RolapMember getDefaultMember()
```
    Specified by:
    
    getDefaultMember in interface MemberReader
  - getMemberParent
```
public RolapMember getMemberParent(RolapMember member)
```
    Specified by:
    
    getMemberParent in interface MemberReader

Class SqlMemberSource

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SqlMemberSource

Method Detail

getHierarchy

setCache

getMemberCount

substitute

desubstitute

getMemberByKey

lookupMember

getLevelMemberCount

getMembers

getMembersInLevel

getMembersInLevel

getMemberCache

getMemberCacheLock

getRootMembers

makeChildMemberSql

levelContainsMultipleColumns

isLevelCollapsed

getMemberChildren

getMemberChildren

getMemberChildren

getMemberChildren

makeMember

allMember

getLeadMember

getMemberRange

compare

getMemberBuilder

getDefaultMember

getMemberParent