SAP BI Java SDK

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

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

public interface IBIAxis
extends IBIIdentifiable

Aggregates a list of dimensions and tuples or members of these dimensions. There are 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.


Method Summary
 List getAxisDimension()
           The list of AxisDimensions oriented along this axis.
 IBIQuery getAxisOwner()
           A reference to the query object that aggregates (owns) this axis.
 IBIQuery getSlicerOwner()
           If an axis is in the role of a slicer, this reference points back to the query that aggregates this slicer.
 IBITupleSet getTupleSet()
           An ordered collection of tuple objects that is aggregated by the axis.
 boolean isSupressingEmptyTuples()
           This attribute indicates to the server whether to completely eliminate empty coordinates from the axis.
 void setSupressingEmptyTuples(boolean newValue)
           This attribute indicates to the server whether to completely eliminate empty coordinates from the axis.
 void setTupleSet(IBITupleSet newValue)
           An ordered collection of tuple objects that is aggregated by the axis.
 
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

isSupressingEmptyTuples

public boolean isSupressingEmptyTuples()
                                throws javax.jmi.reflect.JmiException

This attribute indicates to the server whether to completely eliminate empty coordinates from the axis. If true, empty coordinates are eliminated, otherwise they are retained. A coordinate of the row axis, for example, is considered to be empty if the entire row has only empty cell values.


setSupressingEmptyTuples

public void setSupressingEmptyTuples(boolean newValue)
                              throws javax.jmi.reflect.JmiException

This attribute indicates to the server whether to completely eliminate empty coordinates from the axis. If true, empty coordinates are eliminated, otherwise they are retained. A coordinate of the row axis, for example, is considered to be empty if the entire row has only empty cell values.


getSlicerOwner

public IBIQuery getSlicerOwner()
                        throws javax.jmi.reflect.JmiException

If an axis is in the role of a slicer, this reference points back to the query that aggregates this slicer. For other axes it is null.


getAxisOwner

public IBIQuery getAxisOwner()
                      throws javax.jmi.reflect.JmiException

A reference to the query object that aggregates (owns) this axis. Null for a slicer axis.


getAxisDimension

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

The list of AxisDimensions oriented along this axis. If there are multiple dimensions in this list, the resulting set is derived by crossjoining the membersets of all dimensions.

For an example, see the Main package example #2, in which the two dimensions 'Country' and 'Product' are oriented along an axis, and the resulting tuples are calculated by crossjoining the collections of members of the two IBIAxisDimensions.


getTupleSet

public IBITupleSet getTupleSet()
                        throws javax.jmi.reflect.JmiException

An ordered collection of tuple objects that is aggregated by the axis. 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.


setTupleSet

public void setTupleSet(IBITupleSet newValue)
                 throws javax.jmi.reflect.JmiException

An ordered collection of tuple objects that is aggregated by the axis. 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.


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.