|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.queries.Cursor
public abstract class Cursor
Purpose: Abstract class for CursoredStream and ScrolableCursor
Field Summary | |
---|---|
CursorPolicy |
policy
Query policy that initialize the stream. |
ReadQuery |
query
Read query that initialize the stream. |
Constructor Summary | |
---|---|
Cursor()
INTERNAL: Default constructor. |
|
Cursor(org.eclipse.persistence.internal.databaseaccess.DatabaseCall call,
CursorPolicy policy)
INTERNAL: |
Method Summary | |
---|---|
void |
clear()
PUBLIC: Release all objects read in so far. |
void |
close()
PUBLIC: Closes the stream. |
org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor |
getAccessor()
INTERNAL: Return the accessor associated with the cursor. |
org.eclipse.persistence.internal.sessions.AbstractSession |
getExecutionSession()
INTERNAL: Returns the session the underlying call was executed on. |
Vector<org.eclipse.persistence.internal.helper.DatabaseField> |
getFields()
INTERNAL: Return the fields for the stream. |
Map<Object,Object> |
getInitiallyConformingIndex()
INTERNAL: Conforming instances found in memory when building the result. |
List<Object> |
getObjectCollection()
INTERNAL: Return the internal object collection that stores the objects. |
int |
getPageSize()
INTERNAL: Return the number of items to be faulted in for the stream. |
CursorPolicy |
getPolicy()
INTERNAL: Return the cursor policy. |
abstract int |
getPosition()
INTERNAL: Return the position of the stream inside the object collection. |
ReadQuery |
getQuery()
INTERNAL: Return the query associated with the stream. |
ResultSet |
getResultSet()
INTERNAL: Return the result set (cursor). |
Expression |
getSelectionCriteriaClone()
INTERNAL: The clone of the selection criteria is needed for in-memory conforming each object read from the Cursor. |
org.eclipse.persistence.internal.sessions.AbstractSession |
getSession()
INTERNAL: Return the handle to the session |
boolean |
isClosed()
PUBLIC: Return if the stream is closed. |
void |
remove()
PUBLIC: Remove is not support with cursors. |
void |
setInitiallyConformingIndex(Map<Object,Object> index)
INTERNAL: Conforming instances found in memory when building the result. |
void |
setObjectCollection(List<Object> collection)
INTERNAL: Set the internal object collection |
void |
setPolicy(CursorPolicy policy)
INTERNAL: Set the cursor policy. |
void |
setSelectionCriteriaClone(Expression expression)
INTERNAL: The clone of the selection criteria is needed for in-memory conforming each object read from the Cursor. |
void |
setSession(org.eclipse.persistence.internal.sessions.AbstractSession databaseSession)
INTERNAL: Set the session handle |
void |
setSize(int size)
INTERNAL: Set the cache size |
void |
setTranslationRow(org.eclipse.persistence.internal.sessions.AbstractRecord row)
INTERNAL: Sets the translation row this query was executed with. |
int |
size()
PUBLIC: Retrieve the size of the open cursor by executing a count on the same query as the cursor. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface java.util.Enumeration |
---|
hasMoreElements, nextElement |
Methods inherited from interface java.util.Iterator |
---|
hasNext, next |
Field Detail |
---|
public transient ReadQuery query
public transient CursorPolicy policy
Constructor Detail |
---|
public Cursor()
public Cursor(org.eclipse.persistence.internal.databaseaccess.DatabaseCall call, CursorPolicy policy)
Method Detail |
---|
public void close() throws DatabaseException
DatabaseException
public org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor getAccessor()
public Vector<org.eclipse.persistence.internal.helper.DatabaseField> getFields()
public Map<Object,Object> getInitiallyConformingIndex()
public List<Object> getObjectCollection()
public int getPageSize()
public CursorPolicy getPolicy()
public abstract int getPosition()
public ReadQuery getQuery()
public ResultSet getResultSet()
public Expression getSelectionCriteriaClone()
public org.eclipse.persistence.internal.sessions.AbstractSession getSession()
public org.eclipse.persistence.internal.sessions.AbstractSession getExecutionSession()
public boolean isClosed()
public void setInitiallyConformingIndex(Map<Object,Object> index)
public void setObjectCollection(List<Object> collection)
public void setPolicy(CursorPolicy policy)
public void setSelectionCriteriaClone(Expression expression)
public void setSession(org.eclipse.persistence.internal.sessions.AbstractSession databaseSession)
public void setSize(int size)
public void setTranslationRow(org.eclipse.persistence.internal.sessions.AbstractRecord row)
public int size() throws DatabaseException
DatabaseException
public void remove() throws QueryException
remove
in interface Iterator
QueryException
public void clear()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |