oracle.toplink.queryframework
Class CursoredStreamPolicy

java.lang.Object
  |
  +--oracle.toplink.internal.queryframework.ContainerPolicy
        |
        +--oracle.toplink.queryframework.CursorPolicy
              |
              +--oracle.toplink.queryframework.CursoredStreamPolicy

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class CursoredStreamPolicy

extends CursorPolicy

Purpose: Used to support cursored streams in a read query.

Responsibilities: Execute the cursored read and build the stream.

Since:

TOPLink/Java 1.2

See Also:

Serialized Form

Constructor Summary

CursoredStreamPolicy()
default constructor

CursoredStreamPolicy(ReadQuery query, int pageSize)
set the initial read size to match the page size

CursoredStreamPolicy(ReadQuery query, int initialReadSize, int pageSize)

CursoredStreamPolicy(ReadQuery query, int initialReadSize, int pageSize, ValueReadQuery sizeQuery)

Method Summary

Type	Method
int	getInitialReadSize() Specifies the number of elements to be read initially into a cursored stream.
ValueReadQuery	getSizeQuery() Return the query used to read the size.
boolean	isCursoredStreamPolicy() Is this a Cursored stream?
void	setInitialReadSize(int initialReadSize) Specifies the number of elements to be read initially into a cursored stream
void	setSizeQuery(ValueReadQuery sizeQuery) Set the query used to read the size.

Methods inherited from class oracle.toplink.queryframework.CursorPolicy

getPageSize, isCursorPolicy, isScrollableCursorPolicy, setPageSize

Methods inherited from class oracle.toplink.internal.queryframework.ContainerPolicy

clone, isCollectionPolicy, isCursorStreamPolicy, isListPolicy, isMapPolicy, prepareForExecution, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CursoredStreamPolicy

public CursoredStreamPolicy()

default constructor

CursoredStreamPolicy

public CursoredStreamPolicy(ReadQuery query,
                            int pageSize)

set the initial read size to match the page size

CursoredStreamPolicy

public CursoredStreamPolicy(ReadQuery query,
                            int initialReadSize,
                            int pageSize)

CursoredStreamPolicy

public CursoredStreamPolicy(ReadQuery query,
                            int initialReadSize,
                            int pageSize,
                            ValueReadQuery sizeQuery)

Method Detail

getInitialReadSize

public int getInitialReadSize()

Specifies the number of elements to be read initially into a cursored stream.

getSizeQuery

public ValueReadQuery getSizeQuery()

Return the query used to read the size. This is required for SQL read queries.

isCursoredStreamPolicy

public boolean isCursoredStreamPolicy()

Description copied from class: oracle.toplink.internal.queryframework.ContainerPolicy

Is this a Cursored stream?

Overrides:

isCursoredStreamPolicy in class CursorPolicy

setInitialReadSize

public void setInitialReadSize(int initialReadSize)

Specifies the number of elements to be read initially into a cursored stream

setSizeQuery

public void setSizeQuery(ValueReadQuery sizeQuery)

Set the query used to read the size. This is required for SQL read queries.