SAP BI Java SDK

com.sap.ip.bi.sdk.dac.olap.query.main
Interface IBIAxisDimension

All Superinterfaces:
IBIIdentifiable, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject

public interface IBIAxisDimension
extends IBIIdentifiable

Represents a dimension object that is oriented along an axis of an OLAP query. This is basically an adapter class that is used to list dimension objects in the context of an axis and to endow them with additional features such as selected attributes and calculated members that are meaningful only in the context of a query.


Method Summary
 IBIAxis getAxis()
           A reference to the axis upon which the dimension is projected.
 List getCalculatedMember()
           The list of calculated members associated with this AxisDimension.
 Dimension getDimension()
           The dimension object adapted by this AxisDimension.
 IBIMemberSet getMemberSet()
           A list container used to enumerate MemberSetExpressions.
 Collection getSelectedAttribute()
           A container used to enumerate attributes/features of a dimension that are selected by the server when executing the query. For example, consider a 'Product' dimension that has the attributes 'name,' 'color,' 'weight.'
 void setMemberSet(IBIMemberSet newValue)
           A list container used to enumerate MemberSetExpressions.
 
Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.main.IBIIdentifiable
getDescription, getId, getLabel, setDescription, setId, setLabel
 
Methods inherited from interface javax.jmi.reflect.RefObject
refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite
 
Methods inherited from interface javax.jmi.reflect.RefFeatured
refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue
 
Methods inherited from interface javax.jmi.reflect.RefBaseObject
equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints
 

Method Detail

getDimension

public Dimension getDimension()
                       throws javax.jmi.reflect.JmiException

The dimension object adapted by this AxisDimension.


getAxis

public IBIAxis getAxis()
                throws javax.jmi.reflect.JmiException

A reference to the axis upon which the dimension is projected.


getMemberSet

public IBIMemberSet getMemberSet()
                          throws javax.jmi.reflect.JmiException

A list container used to enumerate MemberSetExpressions. The OLAP Query Model provides two ways to populate an axis with members:

  1. Based on the TupleSet container, which allows a client application to directly list tuples to be contained on the axis.
  2. Based on the MemberSet container associated with each AxisDimension.

Both ways can be used at the same time. The crossjoin is evaluated first, then the tuple set specified by IBITupleSet is joined by union.


setMemberSet

public void setMemberSet(IBIMemberSet newValue)
                  throws javax.jmi.reflect.JmiException

A list container used to enumerate MemberSetExpressions. The OLAP Query Model provides two ways to populate an axis with members:

  1. Based on the TupleSet container, which allows a client application to directly list tuples to be contained on the axis.
  2. Based on the MemberSet container associated with each AxisDimension.

Both ways can be used at the same time. The crossjoin is evaluated first, then the tuple set specified by IBITupleSet is joined by union.


getSelectedAttribute

public Collection getSelectedAttribute()
                                throws javax.jmi.reflect.JmiException

A container used to enumerate attributes/features of a dimension that are selected by the server when executing the query.

For example, consider a 'Product' dimension that has the attributes 'name,' 'color,' 'weight.' By default, a query will select and return only the 'name' attribute for the members selected by the query. To also select the 'color' and 'weight' attributes, the client application needs to specify them by adding them to the list of selectedAttributes.


getCalculatedMember

public List getCalculatedMember()
                         throws javax.jmi.reflect.JmiException

The list of calculated members associated with this AxisDimension. Calculated members represent dimension members whose values are created by applying an arithmetic operation to the values of other selected members. Calculated members can also be defined as measures (calculated measures).

As an example, consider a 'Country' dimension that has the members 'USA' and 'Canada.' To get an aggregated value for these members, a calculated member 'North America' can be created using the operations defined in the input package.


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.