SAP BI Java SDK

SAP BI Java SDK Javadocs
SAP NetWeaver 2004

With the BI Java SDK, you can build analytical applications that access, manipulate, and display both multidimensional (Online Analytical Processing, or OLAP) and tabular (relational) data.

See:
          Description

Connection Interfaces
com.sap.ip.bi.sdk.dac.connector Provides interfaces and implementation for a client to access data from connectors such as the BI Java Connectors.
com.sap.ip.bi.sdk.dac.connector.capabilities Provides functionality to determine whether a given connector supports a particular feature.

 
OLAP Query API
com.sap.ip.bi.sdk.dac.olap.query Contains the OLAP Command Processor and all the sub-packages of the OLAP Query API, generated from the OLAP Query Model, which provides the building blocks for creating OLAP queries.
com.sap.ip.bi.sdk.dac.olap.query.assoc Contains all associations between objects of the model.
com.sap.ip.bi.sdk.dac.olap.query.input Contains IBIInputReference and its subclasses, types of which can be used as input for other expressions, including IBIInputReferences, IBIMemberSelections, IBISetExpressions, and IBIMemberExpressions, and as formulas for IBICalculatedMembers.
com.sap.ip.bi.sdk.dac.olap.query.main Contains the major OLAP query objects that help you build queries to specify multidimensional result sets.
com.sap.ip.bi.sdk.dac.olap.query.member Contains IBIMember, which represents a single and unique value of a dimension, and its associated classes.
com.sap.ip.bi.sdk.dac.olap.query.msx Provides classes for creating MemberSetExpressions, which specify a collection of tuples of members of one dimension (with one member per dimension).
com.sap.ip.bi.sdk.dac.olap.query.tsx Provides classes for creating TupleSetExpressions, which specify a collection of tuples of members of one to many dimensions (with one member per dimension).
com.sap.ip.bi.sdk.dac.olap.query.types Defines eight types, with their corresponding enumerations, that are used as type safe input for other expressions.
com.sap.ip.bi.sdk.dac.olap.query.var Provides classes for the support of SAP variables.

 
Relational Query API
com.sap.ip.bi.sdk.dac.relational.query The main package of the Relational Query API, which provides classes to create and execute relational queries independently of the underlying resource adapter (one of the BI Java Connectors).
com.sap.ip.bi.sdk.dac.relational.query.sapq Provides interfaces for data structures relevant to SAP Query.
com.sap.ip.bi.sdk.dac.relational.query.tree Provides classes and interfaces to represent a WHERE condition in tree form.

 
ResultSet API
com.sap.ip.bi.sdk.dac.result Provides applications created with the SDK with a complete set of interfaces to access the results of a query, delivering a relational result set from a relational data source, and an OLAP result set from an OLAP data source.
com.sap.ip.bi.sdk.dac.result.model Provides classes that define the OLAP Table Model, which facilitates the rendering of a multidimensional data set into a two-dimensional matrix.

 
Exceptions
com.sap.ip.bi.sdk.exception Provides classes and interfaces for handling exceptions thrown by the SDK layer.

 
Utilities
com.sap.ip.bi.sdk.util Provides functionality for configuring logging and tracing, and JARM (monitoring) functionality, via properties files.

 

With the BI Java SDK, you can build analytical applications that access, manipulate, and display both multidimensional (Online Analytical Processing, or OLAP) and tabular (relational) data. This Javadoc overview page is the entrypoint for all documentation related to the BI Java SDK, including:

This overview page introduces the main components and APIs of the BI Java SDK in the following sections:

Components of the SDK

The BI Java SDK provides an object-oriented framework in which to:

The following diagram provides a simplified picture of the core components of the BI Java SDK:

BI Java SDK diagramOLAP Metadata API - from CWM OLAPRelational Metadata API - from CWM RelationalOLAP Query APIRelational Query API - from CWM ExpressionsResultSet APIConnection InterfacesBI Java Connectors

As pictured above, the BI Java SDK consists of the following components:

The SDK's APIs are described in detail in their Javadoc packages, and in the chapters of the Developer's Guide.

The SDK also includes an exception framework, utility interfaces for configuring logging and tracing, and complete documentation and examples.

Connectors

BI Java Connectors are a group of four JCA (J2EE Connector Architecture)-compliant resource adapters that implement the BI Java SDK's APIs and allow you to connect the applications you build with the SDK to heterogeneous data sources. They are deployed to SAP NetWeaver's Web Application Server with the optional BI UDI component.

The BI Java SDK contains the JAR files you need to develop applications using any of the BI Java Connectors and to use them in an unmanaged scenario, but to use your application with a data source in the managed environment of the J2EE server, you need to deploy the appropriate BI Java Connector and create a system with it.

Four connectors are provided:

 

About these Javadocs

The BI Java SDK distribution archive's documentation set interconnects two sets of Javadocs: this set of BI Java SDK Javadocs, and a set of Javadocs for the Common Warehouse Metamodel (CWM) packages upon which the SDK's metadata models and Relational Query Model are built. See Documentation for a complete summary of SDK and CWM packages.

Many of the SDK and CWM packages contain UML class diagrams. The classes or packages in these diagrams are linked to the corresponding Javadoc class or package documentation. Navigate these diagrams in your Web browser for easy, visual access to documentation.

Note:

Due to Javadoc limitations, some links between the SDK and CWM Javadocs may not resolve properly on non-Windows systems. If this is the case for you, you may always navigate from the start pages of the respective Javadoc packages to find specific documentation.

For Additional Information


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.