Package com.google.appengine.api.search

Class Results<T>

java.lang.Object

com.google.appengine.api.search.Results<T>

Type Parameters:

T - The type of search result.

All Implemented Interfaces:

Serializable, Iterable<T>

public class Results<T>
extends Object
implements Iterable<T>, Serializable

Represents a result of executing a search. The Results include an OperationResult, a collection of results, and a number of found and returned results.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
Cursor	getCursor()	A cursor to be used to continue the search after all the results in this search response.
Collection<FacetResult>	getFacets()
long	getNumberFound()	The number of results found by the search.
int	getNumberReturned()
OperationResult	getOperationResult()
Collection<T>	getResults()
Iterator<T>	iterator()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

getOperationResult

public OperationResult getOperationResult()

Returns:

the result of the search operation

getNumberFound

public long getNumberFound()

The number of results found by the search. If the value is less than or equal to the corresponding QueryOptions.getNumberFoundAccuracy(), then it is accurate, otherwise it is an approximation

Returns:

the number of results found

getNumberReturned

public int getNumberReturned()

Returns:

the number of results returned

getResults

public Collection<T> getResults()

Returns:

an unmodifiable collection of search results

getFacets

public Collection<FacetResult> getFacets()

Returns:

an unmodifiable collection of aggregated facets for this search results

getCursor

public Cursor getCursor()

A cursor to be used to continue the search after all the results in this search response. For this field to be populated, use QueryOptions.Builder.setCursor(com.google.appengine.api.search.Cursor) with a value of Cursor.newBuilder().build(), otherwise getCursor() will return null.

Returns:

cursor to be used to get the next set of results after the end of these results, or null if there are no more results to be expected or if no cursor was configured in the QueryOptions.

toString

public String toString()

Overrides:

toString in class Object