SAP BI Java SDK

com.sap.ip.bi.sdk.dac.olap.query.tsx
Interface IBITupleDrill

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

public interface IBITupleDrill
extends IBIDrill, IBITupleSetExpression

An expression in the Drill category, defines a drill operation on a multidimensional set. It provides the ability to identify an individual tuple and within this tuple a single member on which the drill operates. To illustrate how this operation works, consider the following example of a two-dimensional set:

  1. Customer.A ProductGroup.1
  2. Customer.A ProductGroup.2
  3. Customer.B ProductGroup.1
  4. Customer.B ProductGroup.2

If the TupleDrill expression identifies tuple #2 and member Productgroup.2 for the drill operation, the result might be the following:

  1. Customer.A ProductGroup.1
  2. Customer.A Product.1
  3. Customer.A Product.2
  4. Customer.A Product.3
  5. Customer.B ProductGroup.1
  6. Customer.B ProductGroup.2

Note that the drill is only executed for Customer.A, whereas for Customer.B the ProductGroup.2 is not expanded to the product level. This is in contrast to the MemberSetDrill operation which would yield the following result when drilling down on ProductGroup.2:

  1. Customer.A ProductGroup.1
  2. Customer.A Product.1
  3. Customer.A Product.2
  4. Customer.A Product.3
  5. Customer.B ProductGroup.1
  6. Customer.B Product.1
  7. Customer.B Product.2
  8. Customer.B Product.3


Method Summary
 IBIMember getMember()
           The member on which the drill action is executed.
 IBITuple getTuple()
           The tuple on which the drill action operates.
 boolean isZooming()
           Specifies if it should be zoomed in on a member (for the drill direction DOWN) or zoomed out on a member (for the drill direction UP).
 void setMember(IBIMember newValue)
           The member on which the drill action is executed.
 void setTuple(IBITuple newValue)
           The tuple on which the drill action operates.
 void setZooming(boolean newValue)
           Specifies if it should be zoomed in on a member (for the drill direction DOWN) or zoomed out on a member (for the drill direction UP).
 
Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.msx.IBIDrill
getDrillDirection, setDrillDirection
 
Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.main.IBISetExpression
isActive, setActive
 
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
 
Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.tsx.IBITupleSetExpression
getCompositeTupleSetExpression, getTupleSet
 

Method Detail

isZooming

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

Specifies if it should be zoomed in on a member (for the drill direction DOWN) or zoomed out on a member (for the drill direction UP). This is dependent on the drill direction.


setZooming

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

Specifies if it should be zoomed in on a member (for the drill direction DOWN) or zoomed out on a member (for the drill direction UP). This is dependent on the drill direction.


getTuple

public IBITuple getTuple()
                  throws javax.jmi.reflect.JmiException

The tuple on which the drill action operates.


setTuple

public void setTuple(IBITuple newValue)
              throws javax.jmi.reflect.JmiException

The tuple on which the drill action operates.


getMember

public IBIMember getMember()
                    throws javax.jmi.reflect.JmiException

The member on which the drill action is executed. This must be contained in the tuple associated with this expression.


setMember

public void setMember(IBIMember newValue)
               throws javax.jmi.reflect.JmiException

The member on which the drill action is executed. This must be contained in the tuple associated with this expression.


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.