org.eclipse.persistence.internal.sessions.remote

Class RemoteCursoredStream

java.lang.Object

org.eclipse.persistence.queries.Cursor

org.eclipse.persistence.queries.CursoredStream

org.eclipse.persistence.internal.sessions.remote.RemoteCursoredStream

All Implemented Interfaces:

java.io.Serializable, java.util.Enumeration, java.util.Iterator

public class RemoteCursoredStream
extends CursoredStream

Purpose: The object is used as a wrapper to the CursoredStream object in the remote transaction (via RMI, CORBA, etc.)

Responsibilities: Wraps a database result set cursor to provide a stream to the remote client side on the resulting selected objects.

Since:

TOPLink/Java 3.0

Author:

King (Yaoping) Wang

See Also:

Serialized Form

Field Summary

Fields inherited from class org.eclipse.persistence.queries.Cursor

policy, query

Constructor Summary

Constructors

Constructor and Description
RemoteCursoredStream(CursoredStream serverCursoredStream)

Method Summary

Modifier and Type	Method and Description
void	close() Close the wrapped cursored stream This should be performed whenever the user has finished with the stream.
java.rmi.server.ObjID	getID() INTERNAL: Retrieve the OID of the wrapped cursored stream.
boolean	isClosed() INTERNAL: Return if the stream is closed.

Methods inherited from class org.eclipse.persistence.queries.CursoredStream

atEnd, available, buildCountDistinctExpression, clear, getPageSize, getPosition, hasMoreElements, hasNext, mark, markSupported, next, next, nextElement, nextElements, peek, read, read, releasePrevious, reset

Methods inherited from class org.eclipse.persistence.queries.Cursor

getAccessor, getExecutionSession, getFields, getInitiallyConformingIndex, getObjectCollection, getPolicy, getQuery, getResultSet, getSelectionCriteriaClone, getSession, remove, setInitiallyConformingIndex, setObjectCollection, setPolicy, setSelectionCriteriaClone, setSession, setSize, setTranslationRow, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

RemoteCursoredStream

public RemoteCursoredStream(CursoredStream serverCursoredStream)

Method Detail

close

public void close()
           throws DatabaseException

Close the wrapped cursored stream This should be performed whenever the user has finished with the stream.

Overrides:

close in class Cursor

Throws:

DatabaseException

getID

public java.rmi.server.ObjID getID()

INTERNAL: Retrieve the OID of the wrapped cursored stream.

isClosed

public boolean isClosed()

INTERNAL: Return if the stream is closed.

Overrides:

isClosed in class Cursor