Top Description Fields Constructors Methods
org.eclipse.persistence.internal.sessions.remote

public Class RemoteCursoredStream

extends CursoredStream
Class Inheritance
Imports
java.rmi.server.ObjID, java.util.*, org.eclipse.persistence.sessions.remote.*, org.eclipse.persistence.queries.*, org.eclipse.persistence.exceptions.*

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.

Author
King (Yaoping) Wang
Since
TOPLink/Java 3.0

Field Summary

Modifier and TypeField and Description
protected ObjID
id

This is a unique id for remote cursored stream

protected boolean
isClosed

Return if the stream is closed.

protected int
pageSize

Return the cursored stream page size.

Inherited from org.eclipse.persistence.queries.CursoredStream:
marker

Constructor Summary

AccessConstructor and Description
public
RemoteCursoredStream(CursoredStream serverCursoredStream)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides org.eclipse.persistence.queries.Cursor.close.

Close the wrapped cursored stream This should be performed whenever the user has finished with the stream.
protected int
getCursorSize()

Overrides org.eclipse.persistence.queries.CursoredStream.getCursorSize.

INTERNAL: Retreive the size of the wrapped cursored stream.
public ObjID
getID()

INTERNAL: Retrieve the OID of the wrapped cursored stream.

public boolean
isClosed()

Overrides org.eclipse.persistence.queries.Cursor.isClosed.

INTERNAL: Return if the stream is closed.
protected Object
retrieveNextPage()

Overrides org.eclipse.persistence.queries.CursoredStream.retrieveNextPage.

Read the next page of objects from the server.
Inherited from org.eclipse.persistence.queries.CursoredStream:
atEndavailablebuildCountDistinctExpressionclearcopygetInitialReadSizegetMarkergetPageSizegetPositionhasMoreElementshasNextmarkmarkSupportednextnextnextElementnextElementspeekreadreadreleasePreviousresetretrieveNextObjectsetLimitssetMarker

Field Detail

idback to summary
protected ObjID id

This is a unique id for remote cursored stream

isClosedback to summary
protected boolean isClosed

Return if the stream is closed.

pageSizeback to summary
protected int pageSize

Return the cursored stream page size.

Constructor Detail

RemoteCursoredStreamback to summary
public RemoteCursoredStream(CursoredStream serverCursoredStream)

Method Detail

closeback to summary
public void close() throws DatabaseException

Overrides org.eclipse.persistence.queries.Cursor.close.

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

Annotations
@Override
getCursorSizeback to summary
protected int getCursorSize()

Overrides org.eclipse.persistence.queries.CursoredStream.getCursorSize.

INTERNAL: Retreive the size of the wrapped cursored stream.

Annotations
@Override
getIDback to summary
public ObjID getID()

INTERNAL: Retrieve the OID of the wrapped cursored stream.

isClosedback to summary
public boolean isClosed()

Overrides org.eclipse.persistence.queries.Cursor.isClosed.

INTERNAL: Return if the stream is closed.

Annotations
@Override
retrieveNextPageback to summary
protected Object retrieveNextPage() throws DatabaseException

Overrides org.eclipse.persistence.queries.CursoredStream.retrieveNextPage.

Read the next page of objects from the server.

Annotations
@Override