|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractList<E>
java.util.ArrayList<E>
com.crystaldecisions.sdk.occa.report.lib.ClonableList<E>
com.crystaldecisions.sdk.occa.report.lib.ControllableList<E>
com.crystaldecisions.sdk.occa.report.lib.ReportSDKVector<ICursor>
com.crystaldecisions.sdk.occa.report.data.CompositeCursor
public class CompositeCursor
This object is used when there are multiple cursors. Cursors are used to navigate through the records in a record batch. Use the move methods to
navigate around the batch. The getCurrentRecord()
method is used to retrieve the record
that the cursor is currently pointing to.
Cursor is a helper object that inherits much of its behavior from the Rowset
object.
It also acts as a base class from which the RowsetCursor
object and SearchResultCursor
object inherit.
Constructor Summary | |
---|---|
CompositeCursor()
|
|
CompositeCursor(CompositeCursor src)
|
Method Summary | |
---|---|
void |
addNew()
Reserved for future use. |
void |
delete()
Reserved for future use. |
int |
getActiveCursorIndex()
Returns the index value for the active cursor. |
Record |
getCurrentRecord()
The record the cursor is currently pointing at. |
int |
getCurrentRecordNumber()
Returns the record number of the current cursor position. |
int |
getCurrentRecordNumber(FetchedRecordCountInfo info)
Returns the current record number. |
boolean |
getIsTotalRecordKnown()
Returns true if the total number of records is known, and false
otherwise. |
int |
getRecordCount(FetchedRecordCountInfo info)
Returns the record number of the current cursor position. |
boolean |
isEOF()
Returns true if the cursor points to the last record, false otherwise. |
void |
moveFirst()
Moves the cursor to the first record in the batch. |
void |
moveLast()
Moves the cursor to the last record in the batch. |
boolean |
moveNext()
Moves to the next record in the batch. |
boolean |
movePrevious()
Moves to the previous record in the batch. |
boolean |
moveTo(int index)
Moves to a specified record in the batch. |
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ReportSDKVector |
---|
add, add, addElement, elementAt, insertElementAt, isDirectlyControllable, removeAllElements |
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ControllableList |
---|
addAll, addAll, clear, copyTo, doControllerModification, enumerateMembers, getControllableMixin, iterator, listIterator, listIterator, remove, remove, removeAll, retainAll, set, subList |
Methods inherited from class com.crystaldecisions.sdk.occa.report.lib.ClonableList |
---|
clone, createMember, endElement, findIndexOf, hasContent, readElement, save, save, saveContents, startElement |
Methods inherited from class java.util.ArrayList |
---|
clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, size, toArray, toArray, trimToSize |
Methods inherited from class java.util.AbstractList |
---|
equals, hashCode |
Methods inherited from class java.util.AbstractCollection |
---|
containsAll, toString |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.List |
---|
containsAll, equals, hashCode |
Constructor Detail |
---|
public CompositeCursor(CompositeCursor src)
public CompositeCursor()
Method Detail |
---|
public void addNew()
ICursor
Reserved for future use.
addNew
in interface ICursor
public void delete()
ICursor
Reserved for future use.
delete
in interface ICursor
public int getActiveCursorIndex()
Returns the index value for the active cursor.
int
.public Record getCurrentRecord() throws ReportSDKException
ICursor
The record the cursor is currently pointing at. The value returned by this method is updated whenever you move the cursor using any of the move functions.
getCurrentRecord
in interface ICursor
Record
object containing the record the cursor is currently pointing
at.
ReportSDKException
public int getCurrentRecordNumber() throws ReportSDKException
ICursor
Returns the record number of the current cursor position.
getCurrentRecordNumber
in interface ICursor
int
that specifies the record number of the current cursor position.
ReportSDKException
public int getCurrentRecordNumber(FetchedRecordCountInfo info) throws ReportSDKException
Returns the current record number.
info
- The FetchedRecordCountInfo
object.
int
.
ReportSDKException
public boolean getIsTotalRecordKnown() throws ReportSDKException
ICursor
Returns true
if the total number of records is known, and false
otherwise.
Under certain circumstances, the total record count is not known:
true
, then the value of the getRecordCount
method is the final total number of records.
getIsTotalRecordKnown
in interface ICursor
true
if the total number of records is known, and false
otherwise.
ReportSDKException
public int getRecordCount(FetchedRecordCountInfo info) throws ReportSDKException
Returns the record number of the current cursor position.
when a FetchedRecordCountInfo
object is specified.
getRecordCount
in interface ICursor
info
- The FetchedRecordCountInfo
object.
int
.
ReportSDKException
public boolean isEOF() throws ReportSDKException
ICursor
Returns true
if the cursor points to the last record, false
otherwise.
isEOF
in interface ICursor
true
if the cursor points to the last record, false
otherwise.
ReportSDKException
public void moveFirst() throws ReportSDKException
ICursor
Moves the cursor to the first record in the batch.
moveFirst
in interface ICursor
ReportSDKException
public void moveLast() throws ReportSDKException
ICursor
Moves the cursor to the last record in the batch.
moveLast
in interface ICursor
ReportSDKException
public boolean moveNext() throws ReportSDKException
ICursor
Moves to the next record in the batch.
moveNext
in interface ICursor
true
if the cursor advanced successfully, and false
if the
cursor already points to the last record in the batch.
ReportSDKException
public boolean movePrevious() throws ReportSDKException
ICursor
Moves to the previous record in the batch.
movePrevious
in interface ICursor
true
if the cursor advanced successfully, and false
if the
cursor already points to the first record in the batch.
ReportSDKException
public boolean moveTo(int index) throws ReportSDKException
ICursor
Moves to a specified record in the batch. If you supply an index that is out of bounds the method will fail.
moveTo
in interface ICursor
index
- The index of the record in the batch. The batch is zero-based.
true
if there are more records after the index moved to, otherwise false
.
false
will be returned when the move is to the last indexed record.
ReportSDKException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |