org.datanucleus.store.query

Class CandidateIdsQueryResult

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList

org.datanucleus.store.query.AbstractQueryResult

org.datanucleus.store.query.CandidateIdsQueryResult

All Implemented Interfaces:

Serializable, Iterable, Collection, List, QueryResult

public class CandidateIdsQueryResult
extends AbstractQueryResult
implements Serializable

QueryResult taking in the list of identities of the objects of candidate type. This is used where we cached the results of a query (the "ids") and just want to materialise them. User can define the query extension "datanucleus.query.resultCache.type" to define the type of internal caching of objects once they are found. User can also define whether the returned objects are validated against the datastore upon retrieval using the query extension "datanucleus.query.resultCache.validateObjects" (default=true)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CandidateIdsQueryResult.ResultIterator Iterator for results for this query.

Field Summary

Fields inherited from class org.datanucleus.store.query.AbstractQueryResult

closed, connectionListeners, loadResultsAtCommit, LOCALISER, query, resultSizeMethod, size

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
CandidateIdsQueryResult(Query query, List<Object> ids)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeResults() Inform the query result that we are closing the results now.
protected void	closingConnection() Inform the query result that the connection is being closed so perform any operations now, or rest in peace.
boolean	equals(Object o) Equality operator for QueryResults.
Object	get(int index) Method to retrieve a particular element from the list.
protected Object	getObjectForIndex(int index) Convenience method to get the object for a particular index.
Iterator	iterator() Accessor for an iterator for the results.
ListIterator	listIterator() Accessor for a list iterator for the results.
protected Object	writeReplace() Handle serialisation by returning a java.util.ArrayList of all of the results for this query after disconnecting the query which has the consequence of enforcing the load of all objects.

Methods inherited from class org.datanucleus.store.query.AbstractQueryResult

add, add, addAll, addConnectionListener, assertIsOpen, clear, close, contains, containsAll, disconnect, getSizeUsingMethod, hashCode, indexOf, isEmpty, isOpen, lastIndexOf, remove, set, size, subList, toArray, toArray

Methods inherited from class java.util.AbstractList

listIterator, removeRange

Methods inherited from class java.util.AbstractCollection

addAll, remove, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

addAll, remove, removeAll, retainAll

Methods inherited from interface java.util.List

addAll, remove, removeAll, retainAll

Constructor Detail

CandidateIdsQueryResult

public CandidateIdsQueryResult(Query query,
                       List<Object> ids)

Method Detail

closeResults

protected void closeResults()

Description copied from class: AbstractQueryResult

Inform the query result that we are closing the results now.

Specified by:

closeResults in class AbstractQueryResult

closingConnection

protected void closingConnection()

Description copied from class: AbstractQueryResult

Inform the query result that the connection is being closed so perform any operations now, or rest in peace.

Specified by:

closingConnection in class AbstractQueryResult

equals

public boolean equals(Object o)

Description copied from class: AbstractQueryResult

Equality operator for QueryResults. Overrides the AbstractList implementation since that uses size() and iterator() and that would cause problems when closed.

Specified by:

equals in interface Collection

Specified by:

equals in interface List

Specified by:

equals in class AbstractQueryResult

Parameters:

o - The object to compare against

Returns:

Whether they are equal

get

public Object get(int index)

Description copied from class: AbstractQueryResult

Method to retrieve a particular element from the list.

Specified by:

get in interface List

Specified by:

get in class AbstractQueryResult

Parameters:

index - The index of the element

Returns:

The element at index

iterator

public Iterator iterator()

Description copied from class: AbstractQueryResult

Accessor for an iterator for the results.

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Collection

Specified by:

iterator in interface List

Specified by:

iterator in class AbstractQueryResult

Returns:

The iterator

listIterator

public ListIterator listIterator()

Description copied from class: AbstractQueryResult

Accessor for a list iterator for the results.

Specified by:

listIterator in interface List

Specified by:

listIterator in class AbstractQueryResult

Returns:

a ListIterator with the query results

getObjectForIndex

protected Object getObjectForIndex(int index)

Convenience method to get the object for a particular index. Loads the object as required, or takes it from the internal cache (if present). Stores the returned object in the internal cache (if present).

Parameters:

index - The index

Returns:

The object

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Handle serialisation by returning a java.util.ArrayList of all of the results for this query after disconnecting the query which has the consequence of enforcing the load of all objects.

Returns:

The object to serialise

Throws:

ObjectStreamException