SAP BI Java SDK

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

All Known Subinterfaces:
IBIAllFactory

public interface IBIMainFactory

Factory for the main elements of a query. The factory can be retrieved from the IBIQueryFactory, which itself can be retrieved from IBIOlap.

Since:
3.50

Method Summary
 IBIAxis createAxis(boolean suppressingEmptyTuples, boolean distinct, boolean hierarchized)
          Creates and returns a new IBIAxis.
 IBIAxisDimension createAxisDimension(Dimension dimension, boolean distinct, boolean hierarchized)
          Creates and returns a new IBIAxisDimension for the specified dimension.
 IBIQuery createQuery(Cube cube)
          Creates and returns a new IBIQuery for the specified Cube.
 

Method Detail

createQuery

public IBIQuery createQuery(Cube cube)
                     throws BIOlapQueryException
Creates and returns a new IBIQuery for the specified Cube. This method will create an initial query which can be executed and will return a single cell on the columns axis for all available measures.
Parameters:
cube - the cube upon which the query is based
Returns:
the default query which can be immediately executed
Throws:
BIOlapQueryException - if the underlying metadata objects are inconsistent

createAxis

public IBIAxis createAxis(boolean suppressingEmptyTuples,
                          boolean distinct,
                          boolean hierarchized)
Creates and returns a new IBIAxis. By calling this method, an IBITupleSet is automatically created and assigned to the axis. The created objects are initialized with the specified parameters according to their attributes.
Parameters:
suppressingEmptyTuples - the flag suppressingEmptyTuples with which to initialize the IBIAxis
distinct - the distinct flag with which to initialize the automatically-created IBITupleSet
hierarchized - the hierarchized flag with which to initialize the automatically-created IBITupleSet
Returns:
the created axis

createAxisDimension

public IBIAxisDimension createAxisDimension(Dimension dimension,
                                            boolean distinct,
                                            boolean hierarchized)
                                     throws BIOlapQueryException
Creates and returns a new IBIAxisDimension for the specified dimension. By calling that method an IBIMemberSet is automatically created and assigned to the axis dimension. The created objects are initialized with the specified parameters according to their attributes.
Parameters:
dimension - the dimension for which the IBIAxisDimension is created
distinct - the distinct flag with which to initialize the automatically-created IBIMemberSet
hierarchized - the hierarchized flag with which to initialize the automatically-created IBIMemberSet
Returns:
the created axis
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.