EclipseLink Core 4.0.2 · org.eclipse.persistence.queries.ScrollableCursorPolicy

PUBLIC: ScrollableCursorPolicy allows for additional options to be specified for ReadAllQuery or DataReadQuery. These options are passed through to the JDBC result set, the JDBC driver must support JDBC2 scrolling cursors and the options used. Example:

ScrollableCursorPolicy policy = new ScrollableCursorPolicy()

policy.setResultSetType(ScrollableCursorPolicy.TYPE_SCROLL_INSENSITIVE);

query.useScrollableCursor(policy);

Field Summary

Modifier and Type	Field and Description
public static final int	CONCUR_READ_ONLY JDBC 2.0 The concurrency mode for a ResultSet object that may NOT be updated.
public static final int	CONCUR_UPDATABLE JDBC 2.0 The concurrency mode for a ResultSet object that may be updated.
public static final int	FETCH_FORWARD JDBC 2.0 The rows in a result set will be processed in a forward direction; first-to-last.
public static final int	FETCH_REVERSE JDBC 2.0 The rows in a result set will be processed in a reverse direction; last-to-first.
public static final int	FETCH_UNKNOWN JDBC 2.0 The order in which rows in a result set will be processed is unknown.
protected int	resultSetConcurrency
protected int	resultSetType
public static final int	TYPE_FORWARD_ONLY JDBC 2.0 The type for a ResultSet object whose cursor may move only forward.
public static final int	TYPE_SCROLL_INSENSITIVE JDBC 2.0 The type for a ResultSet object that is scrollable but generally not sensitive to changes made by others.
public static final int	TYPE_SCROLL_SENSITIVE JDBC 2.0 The type for a ResultSet object that is scrollable and generally sensitive to changes made by others.

Inherited from org.eclipse.persistence.queries.CursorPolicy:: pageSize query

Constructor Summary

Access	Constructor and Description
public	ScrollableCursorPolicy() PUBLIC: Create a new scrollable cursor policy.
public	ScrollableCursorPolicy(ReadQuery query, int pageSize) INTERNAL: Create a cursor policy with the pagesize.

Method Summary

Modifier and Type	Method and Description
public Object	execute() Implements abstract org.eclipse.persistence.queries.CursorPolicy.execute. INTERNAL: Execute the cursored select and build the stream.
public int	getResultSetConcurrency() PUBLIC: The ResultSetConcurrency specifies if the resultset is updatable.
public int	getResultSetType() PUBLIC: The ResultSetType specifies if the resultset is sensitive to changes made by others.
public boolean	isScrollableCursorPolicy() Overrides org.eclipse.persistence.internal.queries.ContainerPolicy.isScrollableCursorPolicy.
public Object	remoteExecute() Implements abstract org.eclipse.persistence.queries.CursorPolicy.remoteExecute. INTERNAL: Execute the cursored select and build the stream.
public void	setResultSetConcurrency(int resultSetConcurrency) PUBLIC: The ResultSetConcurrency specifies if the resultset is updatable.
public void	setResultSetType(int resultSetType) PUBLIC: The ResultSetType specifies if the resultset is sensitive to changes made by others.

Inherited from org.eclipse.persistence.queries.CursorPolicy:: clone createChangeEvent getPageSize getQuery hasNext isCursorPolicy iteratorFor next overridesRead prepare setPageSize setQuery sizeFor toStringInfo

Field Detail

CONCUR_READ_ONLY	back to summary
public static final int CONCUR_READ_ONLY JDBC 2.0 The concurrency mode for a ResultSet object that may NOT be updated.

CONCUR_UPDATABLE	back to summary
public static final int CONCUR_UPDATABLE JDBC 2.0 The concurrency mode for a ResultSet object that may be updated.

FETCH_FORWARD	back to summary
public static final int FETCH_FORWARD JDBC 2.0 The rows in a result set will be processed in a forward direction; first-to-last.

FETCH_REVERSE	back to summary
public static final int FETCH_REVERSE JDBC 2.0 The rows in a result set will be processed in a reverse direction; last-to-first.

FETCH_UNKNOWN	back to summary
public static final int FETCH_UNKNOWN JDBC 2.0 The order in which rows in a result set will be processed is unknown.

resultSetConcurrency	back to summary
protected int resultSetConcurrency

resultSetType	back to summary
protected int resultSetType

TYPE_FORWARD_ONLY	back to summary
public static final int TYPE_FORWARD_ONLY JDBC 2.0 The type for a ResultSet object whose cursor may move only forward.

TYPE_SCROLL_INSENSITIVE	back to summary
public static final int TYPE_SCROLL_INSENSITIVE JDBC 2.0 The type for a ResultSet object that is scrollable but generally not sensitive to changes made by others.

TYPE_SCROLL_SENSITIVE	back to summary
public static final int TYPE_SCROLL_SENSITIVE JDBC 2.0 The type for a ResultSet object that is scrollable and generally sensitive to changes made by others.

Constructor Detail

ScrollableCursorPolicy	back to summary
public ScrollableCursorPolicy() PUBLIC: Create a new scrollable cursor policy.

ScrollableCursorPolicy	back to summary
public ScrollableCursorPolicy(ReadQuery query, int pageSize) INTERNAL: Create a cursor policy with the pagesize.

Method Detail

execute	back to summary
public Object execute() Implements abstract org.eclipse.persistence.queries.CursorPolicy.execute. INTERNAL: Execute the cursored select and build the stream. Annotations @Override

execute

back to summary

public Object execute()

Implements abstract org.eclipse.persistence.queries.CursorPolicy.execute.

INTERNAL: Execute the cursored select and build the stream.

Annotations

@Override

getResultSetConcurrency	back to summary
public int getResultSetConcurrency() PUBLIC: The ResultSetConcurrency specifies if the resultset is updatable. It is one of, CONCUR_READ_ONLY, CONCUR_UPDATABLE

getResultSetType	back to summary
public int getResultSetType() PUBLIC: The ResultSetType specifies if the resultset is sensitive to changes made by others. It is one of, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE

isScrollableCursorPolicy	back to summary
public boolean isScrollableCursorPolicy() Overrides org.eclipse.persistence.internal.queries.ContainerPolicy.isScrollableCursorPolicy. Annotations @Override

isScrollableCursorPolicy

back to summary

public boolean isScrollableCursorPolicy()

Overrides org.eclipse.persistence.internal.queries.ContainerPolicy.isScrollableCursorPolicy.

Annotations

@Override

remoteExecute	back to summary
public Object remoteExecute() Implements abstract org.eclipse.persistence.queries.CursorPolicy.remoteExecute. INTERNAL: Execute the cursored select and build the stream. Annotations @Override

remoteExecute

back to summary

public Object remoteExecute()

Implements abstract org.eclipse.persistence.queries.CursorPolicy.remoteExecute.

INTERNAL: Execute the cursored select and build the stream.

Annotations

@Override

setResultSetConcurrency	back to summary
public void setResultSetConcurrency(int resultSetConcurrency) PUBLIC: The ResultSetConcurrency specifies if the resultset is updatable. It is one of, CONCUR_READ_ONLY, CONCUR_UPDATABLE

setResultSetType	back to summary
public void setResultSetType(int resultSetType) PUBLIC: The ResultSetType specifies if the resultset is sensitive to changes made by others. It is one of, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE

public Class ScrollableCursorPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail