com.sap.ip.bi.sdk.dac.olap.query
Interface IBIMemberSetFactory

All Superinterfaces:

IBISetFactory

All Known Subinterfaces:

IBIAllFactory

public interface IBIMemberSetFactory

extends IBISetFactory

Factory for all elements which are member set expressions. The factory can be retrieved from IBIQueryFactory, which itself can be retrieved from IBIOlap.

Since:

3.50

Method Summary

IBIChildren	createChildren(IBIMember member, IBIJoinType joinType) Creates IBIChildren for the specified member and initializes it with the specified parameters.
IBICompositeMemberSetExpression	createCompositeMemberSetExpression(IBIJoinType joinType) Creates an IBICompositeMemberSetExpression and initializes it with the specified parameters.
IBIDescendantsLevel	createDescendantsLevel(IBIMember member, Level level, IBIJoinType joinType, boolean self, boolean before, boolean after) Creates IBIDescendantsLevel for the specified member and initializes it with the specified parameters.
IBIDimensionMembers	createDimensionMembers(Dimension dimension, IBIJoinType joinType) Creates IBIDimensionMembers for the specified dimension and initializes it with the specified parameters.
IBIHierarchyMembers	createHierarchyMembers(Hierarchy hierarchy, IBIJoinType joinType) Creates IBIHierarchyMembers for the specified hierarchy and initializes it with the specified parameters.
IBILastPeriods	createLastPeriods(IBIMember member, IBIInputReference index, IBIJoinType joinType) Creates IBILastPeriods for the specified member and initializes it with the specified parameters.
IBILevelDrill	createLevelDrill(Level level, IBIDrillDirectionType drillDirection) Creates an IBILevelDrill which is based on the specified level and initializes it with the specified parameters.
IBILevelMembers	createLevelMembers(Level level, IBIJoinType joinType) Creates IBILevelMembers for the specified level and initializes it with the specified parameters.
IBIMemberDrill	createMemberDrill(IBIMember member, IBIDrillDirectionType drillDirection, boolean zooming) Creates an IBIMemberDrill which is based on the specified member and initializes it with the specified parameters.
IBIMemberList	createMemberList(List members, IBIJoinType joinType) Creates an IBIMemberList for the specified members and initializes it with the specified parameters.
IBIPeriodsToDate	createPeriodsToDate(IBIMember member, IBILevelType levelType, IBIJoinType joinType) Creates IBIPeriodsToDate for the specified member and initializes it with the specified parameters.
IBIPeriodsToDate	createPeriodsToDate(IBIMember member, Level level, IBIJoinType joinType) Creates IBIPeriodsToDate for the specified member and initializes it with the specified parameters.
IBIRange	createRange(IBIMember begin, IBIMember end, IBIJoinType joinType) Creates an IBIRange for the specified members begin and end and initializes it with the specified parameters.

Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.IBISetFactory

createConditionBasedFilter, createRankingFilter, createSort

Method Detail

createCompositeMemberSetExpression

public IBICompositeMemberSetExpression createCompositeMemberSetExpression(IBIJoinType joinType)
                                                                   throws BIOlapQueryException

Creates an IBICompositeMemberSetExpression and initializes it with the specified parameters.

Parameters:

joinType - the joinType with which to initialize the created object

Returns:

the created IBICompositeMemberSetExpression

Throws:

BIOlapQueryException - if null parameters are passed

createLevelDrill

public IBILevelDrill createLevelDrill(Level level,
                                      IBIDrillDirectionType drillDirection)
                               throws BIOlapQueryException

Creates an IBILevelDrill which is based on the specified level and initializes it with the specified parameters.

Parameters:

level - the level on which the created object is based

drillDirection - the drill direction with which to initialize the created object (introduced in SP4)

Returns:

the created IBILevelDrill

Throws:

BIOlapQueryException - if null parameters are passed

createMemberDrill

public IBIMemberDrill createMemberDrill(IBIMember member,
                                        IBIDrillDirectionType drillDirection,
                                        boolean zooming)
                                 throws BIOlapQueryException

Creates an IBIMemberDrill which is based on the specified member and initializes it with the specified parameters.

Parameters:

member - the member on which the created object is based

drillDirection - the drillDirection with which to initialize the created object

zooming - specifies if the drill operation zooms in/out or not

Returns:

the created IBIMemberDrill

Throws:

BIOlapQueryException - if null parameters are passed

createMemberList

public IBIMemberList createMemberList(List members,
                                      IBIJoinType joinType)
                               throws BIOlapQueryException

Creates an IBIMemberList for the specified members and initializes it with the specified parameters.

Parameters:

members - the members of the to-be-created IBIMemberList

joinType - the joinType with which to initialize the created object

Returns:

the created IBIMemberList

Throws:

BIOlapQueryException - if null parameters are passed

createDimensionMembers

public IBIDimensionMembers createDimensionMembers(Dimension dimension,
                                                  IBIJoinType joinType)
                                           throws BIOlapQueryException

Creates IBIDimensionMembers for the specified dimension and initializes it with the specified parameters.

Parameters:

dimension - the dimension for which it is created

joinType - the joinType with which to initialize the created object

Returns:

the created IBIDimensionMembers

Throws:

BIOlapQueryException - if null parameters are passed

createHierarchyMembers

public IBIHierarchyMembers createHierarchyMembers(Hierarchy hierarchy,
                                                  IBIJoinType joinType)
                                           throws BIOlapQueryException

Creates IBIHierarchyMembers for the specified hierarchy and initializes it with the specified parameters.

Parameters:

hierarchy - the hierarchy for which it is created

joinType - the joinType with which to initialize the created object

Returns:

the created IBIHierarchyMembers

Throws:

BIOlapQueryException - if null parameters are passed

createLevelMembers

public IBILevelMembers createLevelMembers(Level level,
                                          IBIJoinType joinType)
                                   throws BIOlapQueryException

Creates IBILevelMembers for the specified level and initializes it with the specified parameters.

Parameters:

level - the level for which it is created

joinType - the joinType with which to initialize the created object

Returns:

the created IBILevelMembers

Throws:

BIOlapQueryException - if null parameters are passed

createChildren

public IBIChildren createChildren(IBIMember member,
                                  IBIJoinType joinType)
                           throws BIOlapQueryException

Creates IBIChildren for the specified member and initializes it with the specified parameters.

Parameters:

member - the member for which it is created

joinType - the joinType with which to initialize the created object

Returns:

the created IBIChildren

Throws:

BIOlapQueryException - if null parameters are passed

createDescendantsLevel

public IBIDescendantsLevel createDescendantsLevel(IBIMember member,
                                                  Level level,
                                                  IBIJoinType joinType,
                                                  boolean self,
                                                  boolean before,
                                                  boolean after)
                                           throws BIOlapQueryException

Creates IBIDescendantsLevel for the specified member and initializes it with the specified parameters.

Parameters:

member - the member for which it is created

level - the level for which it is created

joinType - the joinType with which to initialize the created object

self - the self flag which to initialize the created object

before - the before flag with which to initialize the created object

after - the after flag with which to initialize the created object

Returns:

the created IBIDescendantsLevel

Throws:

BIOlapQueryException - if null parameters are passed

createRange

public IBIRange createRange(IBIMember begin,
                            IBIMember end,
                            IBIJoinType joinType)
                     throws BIOlapQueryException

Creates an IBIRange for the specified members begin and end and initializes it with the specified parameters.

Parameters:

begin - the beginning of the to-be-created range

end - the end of the to-be-created range

joinType - the joinType with which to initialize the created object

Returns:

the created IBIRange

Throws:

BIOlapQueryException - if null parameters are passed

createLastPeriods

public IBILastPeriods createLastPeriods(IBIMember member,
                                        IBIInputReference index,
                                        IBIJoinType joinType)
                                 throws BIOlapQueryException

Creates IBILastPeriods for the specified member and initializes it with the specified parameters.

Parameters:

member - the member for which it is created

index - the index for with which to initialize the created object

joinType - the joinType with which to initialize the created object

Returns:

the created IBILastPeriods

Throws:

BIOlapQueryException - if null parameters are passed

createPeriodsToDate

public IBIPeriodsToDate createPeriodsToDate(IBIMember member,
                                            IBILevelType levelType,
                                            IBIJoinType joinType)
                                     throws BIOlapQueryException

Creates IBIPeriodsToDate for the specified member and initializes it with the specified parameters.

Parameters:

member - the member for which it is created

levelType - the levelType with which to initialize the created object

joinType - the joinType with which to initialize the created object

Returns:

the created IBIPeriodsToDate

Throws:

BIOlapQueryException - if null parameters are passed

createPeriodsToDate

public IBIPeriodsToDate createPeriodsToDate(IBIMember member,
                                            Level level,
                                            IBIJoinType joinType)
                                     throws BIOlapQueryException

Creates IBIPeriodsToDate for the specified member and initializes it with the specified parameters.

Parameters:

member - the member for which it is created

level - the level for which it is created

joinType - the joinType with which to initialize the created object

Returns:

the created IBIPeriodsToDate

Throws:

BIOlapQueryException - if null parameters are passed