Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle TopLink
11g Release 1 (11.1.1)

B32476-02


oracle.toplink.queryframework
Class CursoredStreamPolicy

java.lang.Object
  extended by oracle.toplink.internal.queryframework.ContainerPolicy
      extended by oracle.toplink.queryframework.CursorPolicy
          extended by oracle.toplink.queryframework.CursoredStreamPolicy

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

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
 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()
           
 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, setPageSize

 

Methods inherited from class oracle.toplink.internal.queryframework.ContainerPolicy
clone, isCollectionPolicy, isDirectMapPolicy, isListPolicy, isMapPolicy, isScrollableCursorPolicy, prepareForExecution, recordAddToCollectionInChangeRecord, recordRemoveFromCollectionInChangeRecord, toString

 

Methods inherited from class java.lang.Object
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()
Overrides:
isCursoredStreamPolicy in class oracle.toplink.internal.queryframework.ContainerPolicy

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.

Skip navigation links

Copyright © 1998, 2009, Oracle. All Rights Reserved.