Class SqlMemberSource
- java.lang.Object
-
- mondrian.rolap.SqlMemberSource
-
- All Implemented Interfaces:
MemberReader
,MemberSource
,TupleReader.MemberBuilder
- Direct Known Subclasses:
RolapCubeHierarchy.RolapCubeSqlMemberSource
class SqlMemberSource extends java.lang.Object implements MemberReader, TupleReader.MemberBuilder
ASqlMemberSource
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 Description static class
SqlMemberSource.NullValuePoolFactory
DefaultSqlMemberSource.ValuePoolFactory
implementation, used ifMondrianProperties.SqlMemberSourceValuePoolFactoryClass
is not set.static interface
SqlMemberSource.ValuePoolFactory
Interface definition for the pluggable factory used to decide which implementation ofMap
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 Description SqlMemberSource(RolapHierarchy hierarchy)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 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, java.util.List<java.lang.Comparable> keyValues)
Looks up a member by its key value.MemberCache
getMemberCache()
Returns theMemberCache
to look up members before creating them.java.lang.Object
getMemberCacheLock()
Returns the object which acts as the member cache synchronization lock.void
getMemberChildren(java.util.List<RolapMember> parentMembers, java.util.List<RolapMember> children)
Returns all members which are a child of one of the members inparentMembers
, sorted by ordinal.java.util.Map<? extends Member,Access>
getMemberChildren(java.util.List<RolapMember> parentMembers, java.util.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, java.util.List<RolapMember> children)
Writes all childrenparentMember
tochildren
.java.util.Map<? extends Member,Access>
getMemberChildren(RolapMember parentMember, java.util.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, java.util.List<RolapMember> memberList)
Writes all members betweenstartMember
andendMember
intolist
.java.util.List<RolapMember>
getMembers()
Returns all members of this hierarchy, sorted by ordinal.java.util.List<RolapMember>
getMembersInLevel(RolapLevel level)
Returns all of the members inlevel
whose ordinal lies betweenstartOrdinal
andendOrdinal
.java.util.List<RolapMember>
getMembersInLevel(RolapLevel level, TupleConstraint constraint)
Returns the members in the given Level, optionally applying a constraint.java.util.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 columnRolapMember
lookupMember(java.util.List<Id.Segment> uniqueNameParts, boolean failIfNotFound)
Finds a member based upon its unique name.(package private) Pair<java.lang.String,java.util.List<SqlStatement.Type>>
makeChildMemberSql(RolapMember member, javax.sql.DataSource dataSource, MemberChildrenConstraint constraint)
Generates the SQL statement to access the children ofmember
.RolapMember
makeMember(RolapMember parentMember, RolapLevel childLevel, java.lang.Object value, java.lang.Object captionValue, boolean parentChild, SqlStatement stmt, java.lang.Object key, int columnOffset)
Creates a new member (together with its properties).boolean
setCache(MemberCache cache)
Sets the cache which thisMemberSource
will write to.RolapMember
substitute(RolapMember member)
Substitutes a given member.
-
-
-
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 interfaceMemberSource
-
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.
-
getMemberCount
public int getMemberCount()
Description copied from interface:MemberSource
Returns an estimate of number of members in this hierarchy.- Specified by:
getMemberCount
in interfaceMemberSource
-
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, java.util.List<java.lang.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
-
lookupMember
public RolapMember lookupMember(java.util.List<Id.Segment> uniqueNameParts, boolean failIfNotFound)
Description copied from interface:MemberSource
Finds a member based upon its unique name.- Specified by:
lookupMember
in interfaceMemberSource
-
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
-
getMembers
public java.util.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
-
getMembersInLevel
public java.util.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
-
getMembersInLevel
public java.util.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
-
getMemberCache
public MemberCache getMemberCache()
Description copied from interface:TupleReader.MemberBuilder
Returns theMemberCache
to look up members before creating them.- Specified by:
getMemberCache
in interfaceTupleReader.MemberBuilder
- Returns:
- member cache
-
getMemberCacheLock
public java.lang.Object getMemberCacheLock()
Description copied from interface:TupleReader.MemberBuilder
Returns the object which acts as the member cache synchronization lock.- Specified by:
getMemberCacheLock
in interfaceTupleReader.MemberBuilder
- Returns:
- Object to lock
-
getRootMembers
public java.util.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
-
makeChildMemberSql
Pair<java.lang.String,java.util.List<SqlStatement.Type>> makeChildMemberSql(RolapMember member, javax.sql.DataSource dataSource, MemberChildrenConstraint constraint)
Generates the SQL statement to access the children ofmember
. For example,SELECT "city" FROM "customer" WHERE "country" = 'USA' AND "state_province" = 'BC' GROUP BY "city"
[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)
.
-
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 existslevel
- level- Returns:
- true if agg table has level or not
-
getMemberChildren
public void getMemberChildren(java.util.List<RolapMember> parentMembers, java.util.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 java.util.Map<? extends Member,Access> getMemberChildren(java.util.List<RolapMember> parentMembers, java.util.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 interfaceMemberReader
- Parameters:
parentMembers
- List of members whose children to findchildren
- List to populate with membersmcc
- 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, java.util.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 java.util.Map<? extends Member,Access> getMemberChildren(RolapMember parentMember, java.util.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.
-
makeMember
public RolapMember makeMember(RolapMember parentMember, RolapLevel childLevel, java.lang.Object value, java.lang.Object captionValue, boolean parentChild, SqlStatement stmt, java.lang.Object key, int columnOffset) throws java.sql.SQLException
Description copied from interface:TupleReader.MemberBuilder
Creates a new member (together with its properties).- Specified by:
makeMember
in interfaceTupleReader.MemberBuilder
- Parameters:
parentMember
- Parent memberchildLevel
- Child levelvalue
- Member valuecaptionValue
- CaptionparentChild
- Whether a parent-child hierarchystmt
- SQL statementkey
- Member keycolumnOffset
- Column ordinal (0-based)- Returns:
- new member
- Throws:
java.sql.SQLException
- on error
-
allMember
public RolapMember allMember()
Description copied from interface:TupleReader.MemberBuilder
Returns the 'all' member of the hierarchy.- Specified by:
allMember
in interfaceTupleReader.MemberBuilder
- Returns:
- The 'all' member
-
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, java.util.List<RolapMember> memberList)
Description copied from interface:MemberReader
Writes all members betweenstartMember
andendMember
intolist
.- Specified by:
getMemberRange
in interfaceMemberReader
-
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
-
-