SAP BI Java SDK

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

All Known Subinterfaces:
IBIAllFactory

public interface IBIMemberFactory

Factory for the elements of the com.sap.ip.bi.sdk.dac.olap.query.member package. The factory can be retrieved from IBIQueryFactory, which itself can be retrieved from IBIOlap.

Since:
3.50

Method Summary
 IBIAncestor createAncestor(IBIMember member, Level level)
          Creates an IBIAncestor which is based on the specified member and initializes it with the specified parameters.
 IBICalculatedMember createCalculatedMember(Dimension dimension, IBIInputReference formula, int solveOrder)
          Creates an IBICalculatedMember for the specified dimension and initializes it with the specified parameters.
 IBIClosingPeriod createClosingPeriod(IBIMember member, Level level)
          Creates an IBIClosingPeriod which is based on the specified member and initializes it with the specified parameters.
 IBICousin createCousin(IBIMember member, IBIMember parentMember)
          Creates an IBICousin which is based on the specified member and parent member.
 IBICurrentMember createCurrentMember(Dimension dimension)
          Creates an IBICurrentMember for the specified dimension.
 IBIFirstChild createFirstChild(IBIMember member)
          Creates an IBIFirstChild which is based on the specified member.
 IBIFirstSibling createFirstSibling(IBIMember member)
          Creates an IBIFirstSibling which is based on the specified member.
 IBILag createLag(IBIMember member, IBIInputReference offset)
          Creates an IBILag which is based on the specified member and initializes it with the specified parameters.
 IBILastChild createLastChild(IBIMember member)
          Creates an IBILastChild which is based on the specified member.
 IBILastSibling createLastSibling(IBIMember member)
          Creates an IBILastSibling which is based on the specified member.
 IBILead createLead(IBIMember member, IBIInputReference offset)
          Creates an IBILead which is based on the specified member and initializes it with the specified parameters.
 IBIMember createMember(Dimension dimension, String memberName, Map attributes, Map taggedValues)
          Creates a member for the specified dimension.
 IBINextMember createNextMember(IBIMember member)
          Creates an IBINextMember which is based on the specified member.
 IBIOpeningPeriod createOpeningPeriod(IBIMember member, Level level)
          Creates an IBIOpeningPeriod which is based on the specified member and initializes it with the specified parameters.
 IBIParallelPeriod createParallelPeriod(IBIMember member, Level level, IBIInputReference offset)
          Creates an IBIParallelPeriod which is based on the specified member and initializes it with the specified parameters.
 IBIParent createParent(IBIMember member)
          Creates an IBIParent which is based on the specified member.
 IBIPreviousMember createPreviousMember(IBIMember member)
          Creates an IBIPreviousMember which is based on the specified member.
 

Method Detail

createMember

public IBIMember createMember(Dimension dimension,
                              String memberName,
                              Map attributes,
                              Map taggedValues)
                       throws BIOlapQueryException
Creates a member for the specified dimension.

The member is initialized with the provided parameters (see parameters for details). For ODBO, for example, there must be a TaggedValue with the key MEMBER_UNIQUE_NAME to specify the unique identifying name for the member.
Parameters:
dimension - the dimension for which the member should be created
memberName - the name of the member
attributes - the attributes which are taken to create Slots for the member. For each Map entry a slot is created which references an Attribute and an IBIAnyDataValue. The Attribute is taken from the key part of the Map. For the IBIAnyDataValue the value part of the Map entry is used and must be a Java Wrapper class type.
taggedValues - the Map which contains keys and values both of type String. These key value pairs are used to create taggedValues of type TaggedValue for the member.
Returns:
the created member
Throws:
BIOlapQueryException - if dimension, memberName or taggedValues is null

createCurrentMember

public IBICurrentMember createCurrentMember(Dimension dimension)
                                     throws BIOlapQueryException
Creates an IBICurrentMember for the specified dimension.
Parameters:
dimension - the dimension for which it is created
Returns:
the created IBICurrentMember
Throws:
BIOlapQueryException - if null parameters are passed

createCalculatedMember

public IBICalculatedMember createCalculatedMember(Dimension dimension,
                                                  IBIInputReference formula,
                                                  int solveOrder)
                                           throws BIOlapQueryException
Creates an IBICalculatedMember for the specified dimension and initializes it with the specified parameters.
Parameters:
dimension - the dimension for which it is created
formula - the formula which specifies how to calculate the IBICalculatedMember
solveOrder - the solveOrder with which to initialize the IBICalculatedMember
Returns:
the created IBICalculatedMember
Throws:
BIOlapQueryException - if null parameters are passed

createNextMember

public IBINextMember createNextMember(IBIMember member)
                               throws BIOlapQueryException
Creates an IBINextMember which is based on the specified member.
Parameters:
member - the member on which it is based
Returns:
the created IBINextMember
Throws:
BIOlapQueryException - if null parameters are passed

createParent

public IBIParent createParent(IBIMember member)
                       throws BIOlapQueryException
Creates an IBIParent which is based on the specified member.
Parameters:
member - the member on which it is based
Returns:
the created IBIParent
Throws:
BIOlapQueryException - if null parameters are passed

createPreviousMember

public IBIPreviousMember createPreviousMember(IBIMember member)
                                       throws BIOlapQueryException
Creates an IBIPreviousMember which is based on the specified member.
Parameters:
member - the member on which it is based
Returns:
the created IBIPreviousMember
Throws:
BIOlapQueryException - if null parameters are passed

createCousin

public IBICousin createCousin(IBIMember member,
                              IBIMember parentMember)
                       throws BIOlapQueryException
Creates an IBICousin which is based on the specified member and parent member.
Parameters:
member - the member on which it is based
parentMember - the parent member on which it is based
Returns:
the created IBICousin
Throws:
BIOlapQueryException - if null parameters are passed

createFirstChild

public IBIFirstChild createFirstChild(IBIMember member)
                               throws BIOlapQueryException
Creates an IBIFirstChild which is based on the specified member.
Parameters:
member - the member on which it is based
Returns:
the created IBIFirstChild
Throws:
BIOlapQueryException - if null parameters are passed

createFirstSibling

public IBIFirstSibling createFirstSibling(IBIMember member)
                                   throws BIOlapQueryException
Creates an IBIFirstSibling which is based on the specified member.
Parameters:
member - the member on which it is based
Returns:
the created IBIFirstSibling
Throws:
BIOlapQueryException - if null parameters are passed

createLastChild

public IBILastChild createLastChild(IBIMember member)
                             throws BIOlapQueryException
Creates an IBILastChild which is based on the specified member.
Parameters:
member - the member on which it is based
Returns:
the created IBILastChild
Throws:
BIOlapQueryException - if null parameters are passed

createLastSibling

public IBILastSibling createLastSibling(IBIMember member)
                                 throws BIOlapQueryException
Creates an IBILastSibling which is based on the specified member.
Parameters:
member - the member on which it is based
Returns:
the created IBILastSibling
Throws:
BIOlapQueryException - if null parameters are passed

createLead

public IBILead createLead(IBIMember member,
                          IBIInputReference offset)
                   throws BIOlapQueryException
Creates an IBILead which is based on the specified member and initializes it with the specified parameters.
Parameters:
member - the member on which it is based
offset - the offset with which to initialize the created object
Returns:
the created IBILead
Throws:
BIOlapQueryException - if null parameters are passed

createLag

public IBILag createLag(IBIMember member,
                        IBIInputReference offset)
                 throws BIOlapQueryException
Creates an IBILag which is based on the specified member and initializes it with the specified parameters.
Parameters:
member - the member on which it is based
offset - the offset with which to initialize the created object
Returns:
the created IBILag
Throws:
BIOlapQueryException - if null parameters are passed

createAncestor

public IBIAncestor createAncestor(IBIMember member,
                                  Level level)
                           throws BIOlapQueryException
Creates an IBIAncestor which is based on the specified member and initializes it with the specified parameters.
Parameters:
member - the member on which it is based
level - the level with which to initialize the created object
Returns:
the created IBIAncestor
Throws:
BIOlapQueryException - if null parameters are passed

createOpeningPeriod

public IBIOpeningPeriod createOpeningPeriod(IBIMember member,
                                            Level level)
                                     throws BIOlapQueryException
Creates an IBIOpeningPeriod which is based on the specified member and initializes it with the specified parameters.
Parameters:
member - the member on which it is based
level - the level with which to initialize the created object
Returns:
the created IBIOpeningPeriod
Throws:
BIOlapQueryException - if null parameters are passed

createClosingPeriod

public IBIClosingPeriod createClosingPeriod(IBIMember member,
                                            Level level)
                                     throws BIOlapQueryException
Creates an IBIClosingPeriod which is based on the specified member and initializes it with the specified parameters.
Parameters:
member - the member on which it is based
level - the level with which to initialize the created object
Returns:
the created IBIClosingPeriod
Throws:
BIOlapQueryException - if null parameters are passed

createParallelPeriod

public IBIParallelPeriod createParallelPeriod(IBIMember member,
                                              Level level,
                                              IBIInputReference offset)
                                       throws BIOlapQueryException
Creates an IBIParallelPeriod which is based on the specified member and initializes it with the specified parameters.
Parameters:
member - the member on which it is based
level - the level with which to initialize the created object
offset - an IBIInputReference object which specifies the offset for the parallel period
Returns:
the created IBIParallelPeriod
Throws:
BIOlapQueryException - if null parameters are passed

SAP BI Java SDK

Copyright © 2004-2006 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.