SAP BI Java SDK

com.sap.ip.bi.sdk.dac.result
Interface IBIDataSet

All Superinterfaces:
IBICellCursor, IBIResultSet, com.sap.ip.bi.sdk.dac.result.impl.IBIResultSet, com.sap.ip.bi.sdk.dac.result.impl.IBISynchronizeCursor, ResultSet

public interface IBIDataSet
extends IBICellCursor

Provides access to and navigation of the results of a multidimensional query. IBIDataSet is an extension of IBIResultSet, using an instance of IBIResultSet for each axis (also referred to as axis cursors). IBIDataSet implements IBIResultSet itself to allow access to the cells of such a result. IBIDataSet synchronizes all of these IBIResultSet instances so that the navigation along one or more of the axis cursors automatically positions the cell cursor correctly.

Since:
3.50

Inner classes inherited from class com.sap.ip.bi.sdk.dac.result.impl.IBIResultSet
com.sap.ip.bi.sdk.dac.result.impl.IBIResultSet.Type
 
Field Summary
static int COLUMNS
          The ordinal of the axis cursor for the columns axis.
static int PAGES
          The ordinal of the axis cursor for the pages axis.
static int ROWS
          The ordinal of the axis cursor for the rows axis.
 
Fields inherited from interface com.sap.ip.bi.sdk.dac.result.IBICellCursor
MANDATORY, OPTIONAL
 
Fields inherited from interface java.sql.ResultSet
CONCUR_READ_ONLY, CONCUR_UPDATABLE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE
 
Method Summary
 List getAxisCursor()
          Gets the list of all axis cursors.
 IBIAxisCursor getAxisCursor(int axisOrdinal)
          Gets the axis cursor specified by the ordinal (index) provided.
 Object getSource()
          Gets the query object used to request this result set.
 
Methods inherited from interface com.sap.ip.bi.sdk.dac.result.impl.IBIResultSet
isSynchronized, setSynchronized, synchAbsolute, synchAfterLast, synchBeforeFirst, synchGetColumnCount, synchGetRow, synchGetRowCount, synchRelative, synchronize
 
Methods inherited from interface java.sql.ResultSet
absolute, afterLast, beforeFirst, cancelRowUpdates, clearWarnings, close, deleteRow, findColumn, first, getArray, getArray, getAsciiStream, getAsciiStream, getBigDecimal, getBigDecimal, getBigDecimal, getBigDecimal, getBinaryStream, getBinaryStream, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getConcurrency, getCursorName, getDate, getDate, getDate, getDate, getDouble, getDouble, getFetchDirection, getFetchSize, getFloat, getFloat, getInt, getInt, getLong, getLong, getMetaData, getObject, getObject, getObject, getObject, getRef, getRef, getRow, getShort, getShort, getStatement, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getType, getUnicodeStream, getUnicodeStream, getWarnings, insertRow, isAfterLast, isBeforeFirst, isFirst, isLast, last, moveToCurrentRow, moveToInsertRow, next, previous, refreshRow, relative, rowDeleted, rowInserted, rowUpdated, setFetchDirection, setFetchSize, updateAsciiStream, updateAsciiStream, updateBigDecimal, updateBigDecimal, updateBinaryStream, updateBinaryStream, updateBoolean, updateBoolean, updateByte, updateByte, updateBytes, updateBytes, updateCharacterStream, updateCharacterStream, updateDate, updateDate, updateDouble, updateDouble, updateFloat, updateFloat, updateInt, updateInt, updateLong, updateLong, updateNull, updateNull, updateObject, updateObject, updateObject, updateObject, updateRow, updateShort, updateShort, updateString, updateString, updateTime, updateTime, updateTimestamp, updateTimestamp, wasNull
 

Field Detail

COLUMNS

public static final int COLUMNS
The ordinal of the axis cursor for the columns axis.

ROWS

public static final int ROWS
The ordinal of the axis cursor for the rows axis.

PAGES

public static final int PAGES
The ordinal of the axis cursor for the pages axis.
Method Detail

getAxisCursor

public List getAxisCursor()
                   throws SQLException
Gets the list of all axis cursors. The order of the cursors in the list are (COLUMNS=0, ROWS=1, PAGES=2, ...).
Returns:
the list of all axis cursors
Throws:
SQLException - when no axis cursors exist

getAxisCursor

public IBIAxisCursor getAxisCursor(int axisOrdinal)
                            throws SQLException
Gets the axis cursor specified by the ordinal (index) provided.
Parameters:
axisOrdinal - the ordinal of the axis cursor
Returns:
the axis cursor specified by axisName
Throws:
SQLException - when no axis cursor with the supplied ordinal axisOrdinal exists

getSource

public Object getSource()
                 throws SQLException
Gets the query object used to request this result set.
Returns:
the query object used to request this result set
Throws:
SQLException - when no such query object exists or can be retrieved

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.