SAP BI Java SDK

Package com.sap.ip.bi.sdk.dac.olap.query.var

Provides classes for the support of SAP variables.

See:
          Description

Interface Summary
IBISapHierarchyValue Adapter to a value of type Hierarchy, specifies a value for an SAP variable of type IBISapHierarchyVariable.
IBISapHierarchyVariable Variable for which you must specify a single value of type Hierarchy.
IBISapMemberValueRange Adapter to a value of type IBIMember, specifies a value for a SAP variable of type IBISapMemberVariable.
IBISapMemberVariable Variable for which you must specify a value of type IBIMember.
IBISapNumericValueRange Adapter to a numeric value, specifies a value for a SAP variable of type IBISapNumericVariable.
IBISapNumericVariable Variable for which you must specify a numeric value.
IBISapVariable Abstract supertype for the three different types of SAP variables.
IBISapVariableValue Abstract supertype of all SAP variable value types.
IBISapVariableValueRange Supertype of all SAP variable value range types.
 

Package com.sap.ip.bi.sdk.dac.olap.query.var Description

Provides classes for the support of SAP variables. In BW, you can use variables to parameterize queries. For example, you could create a query for a monthly report, and then parameterize it with the current month using SAP variables.

Since these variables can be used in BW's Open Analysis Interfaces, they therefore are supported in the BI Java SDK by using various BW-specific enhancements to the MDX syntax.

The classes related to SAP variable support in the OLAP Query Model are diagrammed below:

Variables diagramAttribute (from Core)StructuralFeature (from Core)Slot (from Instance)IBISapVariableIBISapHierarchyVariableIBISapMemberVariableIBISapNumericVariable Slot (from Instance)

An OLAP query in BW (which corresponds to the CWM Cube in the query model) can have zero to many SAP variables associated with it. As you can see from the diagram, and as depicted in the Main Model diagram, support for this in the query model is provided by the Slot (see Member for more about slots).

Each slot associates a variable with a value or a number of values. Variable values and their associated classes are diagrammed below:

Variable Values diagramSlot (from Instance) Instance (from Instance) IBISapVariableValueIBISapHierarchyValueIBISapVariableValueRangeIBISapMemberValueRangeIBISapNumericValueRange

Variable values are specified by selection types (see IBISapVariableSelectionType in the Variables diagram, above). There are three types of variables, and each specifies a particular selection type:

SAP Variable Selection Type
IBISapHierarchyVariable Single value (you can specify only one hierarchy)
IBISapMemberVariable Single value / interval / complex selection
IBISapNumericVariable Single value / interval / complex selection

Single values simply select a single value, such as a Member. With an interval, you can select a range of values. With complex selection, you can select complex sets of collections of ranges and single values, including and excluding selections as well.

For an example of working with SAP variables in the SDK, see Olap_10.java on the Examples page.

Since:
3.50 SP2

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.