Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap.data
Interface OlapCursor

All Known Subinterfaces:
TabularCursor, TupleCursor, ValueCursor

public interface OlapCursor

OlapCursor is used to iterate through the results of an olap selection.


Method Summary
 int getPosition()
          Returns the current position in the cursor.
 int getPositionCount()
          Returns the total number of members that the cursor contains.
 boolean next()
          Moves the cursor to the next location.
 void reset()
          Resets the cursor by moving the position to the beginning.
 void setPosition(int position)
          Moves the cursor to a specified position.
 

Method Detail

getPosition

int getPosition()
Returns the current position in the cursor.

Returns:
the cursor's current position

getPositionCount

int getPositionCount()
Returns the total number of members that the cursor contains.

Returns:
the total number of iterations

next

boolean next()
             throws OlapCursorException
Moves the cursor to the next location.

Throws:
OlapCursorException

reset

void reset()
           throws OlapCursorException
Resets the cursor by moving the position to the beginning.

Throws:
OlapCursorException

setPosition

void setPosition(int position)
                 throws OlapCursorException
Moves the cursor to a specified position.

Parameters:
position - the location to set the cursor to
Throws:
OlapCursorException

Copyright © 2011 Citra Technologies. All Rights Reserved.