SAP BI Java SDK

com.sap.ip.bi.sdk.dac.connector
Interface IBIOlap


public interface IBIOlap

Serves as an entry point to interfaces that support access to multidimensional metadata and queries. This interface, retrieved from IBIConnection, is implemented by all OLAP connectors. It provides OLAP data source functionality including retrieval of metadata, creation of the cubeView, and retrieval of data. Every OLAP connector needs to implement this interface in order to support the functionality specified in it.

Since:
3.50

Inner Class Summary
static class IBIOlap.Supports
          Returns Boolean.TRUE or Boolean.FALSE, depending on what kind of features the OLAP provider supports.
 
Method Summary
 IBIQuery createQuery(Cube cube)
          Creates and returns a new IBIQuery object for the specified Cube.
 IBIDataSet execute(Object nativeQuery)
          Returns the result of the query.
 List getCube()
          Returns the list of available cubes in the system.
 IBIOlapObjectFinder getObjectFinder()
          Returns an instance of IBIOlapObjectFinder which supports the search for OLAP schema objects.
 IBIQueryFactory getQueryFactory()
          Returns the class that provides the factory methods for all objects needed in the context of a query.
 List getSchema()
          Returns the list of available schemas in the system.
 Collection getTaggedValue(ModelElement element)
          Returns the collection of taggedValues for a given ModelElement, such as Cube or Dimension.
 javax.jmi.reflect.RefPackage getTopLevelPackage()
          Returns the metadata package of the current connection.
 Boolean supports(IBIOlap.Supports feature)
          Returns true or false, depending on whether the queried feature is supported or not.
 

Method Detail

supports

public Boolean supports(IBIOlap.Supports feature)
Returns true or false, depending on whether the queried feature is supported or not.
Parameters:
feature - a feature that can be supported by a specific connector
Returns:
true if the queried feature is supported; false if not
Since:
3.50 SP3

getCube

public List getCube()
             throws BIResourceException
Returns the list of available cubes in the system.
Returns:
the list of available cubes in the connected system. Each list entry is of type Cube
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of cubes (null is valid)

getSchema

public List getSchema()
               throws BIResourceException
Returns the list of available schemas in the system.
Returns:
the list of available schemas in the connected system. Each list entry is of type Schema
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid list of schemas (null is valid)

getTopLevelPackage

public javax.jmi.reflect.RefPackage getTopLevelPackage()
                                                throws BIResourceException
Returns the metadata package of the current connection.
Returns:
the metadata package of the current connection
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid RefPackage (null is valid)

execute

public IBIDataSet execute(Object nativeQuery)
                   throws BIResourceException
Returns the result of the query. The query is specified in a source system-dependent way, for example in an MDX string in the case of ODBO.
Parameters:
nativeQuery - the native specification of the query
Returns:
the returned result set
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid IBIDataSet implementation (null is valid)

createQuery

public IBIQuery createQuery(Cube cube)
                     throws BIOlapQueryException
Creates and returns a new IBIQuery object for the specified Cube. This method will create an initial query which can be executed and will return for all available measures a single cell on the columns axis.
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

getQueryFactory

public IBIQueryFactory getQueryFactory()
Returns the class that provides the factory methods for all objects needed in the context of a query.
Returns:
IBIQueryFactory, the factory class

getTaggedValue

public Collection getTaggedValue(ModelElement element)
                          throws BIResourceException
Returns the collection of taggedValues for a given ModelElement, such as Cube or Dimension.
Parameters:
element - ModelElement for taggedValue
Returns:
taggedValue collection
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid Collection of TaggedValues (null is valid)

getObjectFinder

public IBIOlapObjectFinder getObjectFinder()
                                    throws BIResourceException
Returns an instance of IBIOlapObjectFinder which supports the search for OLAP schema objects.
Returns:
the object finder
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid implementation of IBIOlapObjectFinder (null is valid)

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.