SAP BI Java SDK

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

All Superinterfaces:
IBIResultSet, ResultSet

public interface IBIDimensionCursor
extends IBIResultSet

A cursor to allow navigation of a dimension of a multidimensional result set (IBIDataSet) as well as access to metadata describing the cursor. A dimension cursor contains mandatory columns (accessible either by their column index or column name) as well as any number of optional columns (accessible only by their column name). See java.sql.ResultSet for further details on the navigation model.

Since:
3.50

Field Summary
static IBICursorColumn[] MANDATORY
          The mandatory columns (fixed order).
static IBICursorColumn[] OPTIONAL
          The optional columns.
 
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
 IBIAxisCursor getAxisCursor()
          Gets the enclosing axis cursor.
 Object getDimension()
          Gets the dimension instance corresponding to the current navigation state of this dimension cursor.
 List getDimensionAttributeCursor()
          Gets the list of attribute cursors contained in this dimension cursor.
 Object getMember()
          Gets the member instance corresponding to the current navigation state of this dimension cursor.
 String getName()
          The name of this dimension cursor.
 
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

MANDATORY

public static final IBICursorColumn[] MANDATORY
The mandatory columns (fixed order).

OPTIONAL

public static final IBICursorColumn[] OPTIONAL
The optional columns.

Note: the order in which the columns occur, if they do, is not fixed.
Method Detail

getName

public String getName()
The name of this dimension cursor.
Returns:
the name

getAxisCursor

public IBIAxisCursor getAxisCursor()
Gets the enclosing axis cursor.
Returns:
the axis cursor.

getDimensionAttributeCursor

public List getDimensionAttributeCursor()
                                 throws SQLException
Gets the list of attribute cursors contained in this dimension cursor.
Returns:
the list of attribute cursors.
Throws:
SQLException - when this operation is not supported or the metadata access fails.

getDimension

public Object getDimension()
                    throws SQLException
Gets the dimension instance corresponding to the current navigation state of this dimension cursor.
Returns:
the dimension instance
Throws:
SQLException - when this operation is not supported or the metadata access fails

getMember

public Object getMember()
                 throws SQLException
Gets the member instance corresponding to the current navigation state of this dimension cursor.
Returns:
the member instance
Throws:
SQLException - when this operation is not supported or the metadata access fails

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.