|
Oracle Fusion Middleware Java API Reference for Oracle TopLink (Deprecated) 11g Release 1 (11.1.1) B32476-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.toplink.queryframework.Cursor oracle.toplink.queryframework.CursoredStream
public class CursoredStream
Purpose: Stream class which is used to deal with large collections returned from TOPLink queries more efficiently.
Responsibilities: Wraps a database result set cursor to provide a stream on the resulting selected objects.
Field Summary |
---|
Fields inherited from class oracle.toplink.queryframework.Cursor |
---|
policy |
Method Summary | |
---|---|
boolean |
atEnd()
Return whether the cursored stream is at its end. |
int |
available()
Returns the number of objects that can be read from this input without blocking. |
boolean |
hasMoreElements()
Return whether the cursored stream has any more elements. |
void |
mark(int readAheadLimit)
Mark the present position in the stream. |
boolean |
markSupported()
Tests if this input stream supports the mark
and reset methods. |
java.lang.Object |
nextElement()
Return the next object from the collection, if beyond the read limit read from the cursor. |
java.util.Vector |
nextElements(int numberOfElements)
Return a Vector of at most numberOfElements of the next objects from the collection. |
java.lang.Object |
peek()
Return the next object in the stream, without increamenting the stream's position. |
java.lang.Object |
read()
This method differs slightly from conventinal read() operation on a Java stream. |
java.util.Vector |
read(int number)
This method differs slightly from conventinal read() operation on a Java stream. |
void |
releasePrevious()
Release all objects read in so far. |
void |
reset()
Repositions this stream to the position at the time the mark method was last called on this stream. |
Methods inherited from class oracle.toplink.queryframework.Cursor |
---|
close, isClosed, size |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public boolean atEnd() throws DatabaseException
DatabaseException
public int available() throws DatabaseException
DatabaseException
public boolean hasMoreElements()
public void mark(int readAheadLimit)
readAheadLimit
- Limit on the number of characters that may be
read while still preserving the mark. Because
the stream's input comes from the database, there
is no actual limit, so this argument is ignored.public boolean markSupported()
mark
and reset
methods. The markSupported
method of InputStream
returns false
.
public java.lang.Object nextElement()
public java.util.Vector nextElements(int numberOfElements)
public java.lang.Object peek() throws DatabaseException
DatabaseException
public java.lang.Object read() throws DatabaseException, QueryException
-
- throws exception if read pass end of stream
DatabaseException
QueryException
public java.util.Vector read(int number) throws DatabaseException
number
- - number of objects to be returned
-
- throws exception if read pass end of stream
DatabaseException
public void releasePrevious()
public void reset()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |