org.mongodb.morphia.query

Interface QueryResults<T>

Type Parameters:

T -

All Superinterfaces:

Iterable<T>

All Known Subinterfaces:

Query<T>

All Known Implementing Classes:

QueryImpl

public interface QueryResults<T>
extends Iterable<T>

The results of a query. These results aren't materialized until a method on this interface is called.

Method Summary

Modifier and Type	Method and Description
List<Key<T>>	asKeyList() Execute the query and get the results (as a List<Key<T>>) This method is provided as a convenience;
List<T>	asList() Execute the query and get the results.
long	countAll() Count the total number of values in the result, ignoring limit and offset
MorphiaIterator<T,T>	fetch() Execute the query and get the results.
MorphiaIterator<T,T>	fetchEmptyEntities() Execute the query and get only the ids of the results.
MorphiaKeyIterator<T>	fetchKeys() Execute the query and get the keys for the objects.
T	get() Gets the first entity in the result set.
Key<T>	getKey() Get the key of the first entity in the result set.
MorphiaIterator<T,T>	tail() Calls tail(true);
MorphiaIterator<T,T>	tail(boolean awaitData) Returns an tailing iterator over a set of elements of type T.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

asKeyList

List<Key<T>> asKeyList()

Execute the query and get the results (as a List<Key<T>>) This method is provided as a convenience;

Returns:

returns a List of the keys of the documents returned by a query

asList

List<T> asList()

Execute the query and get the results.

Returns:

returns a List of the documents returned by a query

countAll

long countAll()

Count the total number of values in the result, ignoring limit and offset

Returns:

the count

fetch

MorphiaIterator<T,T> fetch()

Execute the query and get the results. This method is provided for orthogonality; Query.fetch().iterator() is identical to Query.iterator().

Returns:

an Iterator of the results

fetchEmptyEntities

MorphiaIterator<T,T> fetchEmptyEntities()

Execute the query and get only the ids of the results. This is more efficient than fetching the actual results (transfers less data).

Returns:

an Iterator of the empty entities

fetchKeys

MorphiaKeyIterator<T> fetchKeys()

Execute the query and get the keys for the objects.

Returns:

the Key Iterator

See Also:

fetchEmptyEntities()

get

T get()

Gets the first entity in the result set. Obeys the Query offset value.

Returns:

the only instance in the result, or null if the result set is empty.

getKey

Key<T> getKey()

Get the key of the first entity in the result set. Obeys the Query offset value.

Returns:

the key of the first instance in the result, or null if the result set is empty.

tail

MorphiaIterator<T,T> tail()

Calls tail(true);

Returns:

an Iterator.

See Also:

tail(boolean)

tail

MorphiaIterator<T,T> tail(boolean awaitData)

Returns an tailing iterator over a set of elements of type T. If awaitData is true, this iterator blocks on hasNext() until new data is avail (or some amount of time has passed). Note that if no data is available at all, hasNext() might return immediately. You should wrap tail calls in a loop if you want this to be blocking.

Parameters:

awaitData - passes the awaitData to the cursor

Returns:

an Iterator.

See Also:

Bytes.QUERYOPTION_AWAITDATA