io.orchestrate.client

Class SearchResults<T>

java.lang.Object

io.orchestrate.client.SearchResults<T>

Type Parameters:

T - The deserializable type for the KV objects in the search results.

All Implemented Interfaces:

java.lang.Iterable<Result<T>>

public class SearchResults<T>
extends java.lang.Object
implements java.lang.Iterable<Result<T>>

A container for the results from a search query.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<AggregateResult>	getAggregates() Returns the aggregate results associated with these search results.
int	getCount() Returns the number of search results.
OrchestrateRequest<SearchResults<T>>	getNext() The Request for fetching the next page of the search results.
OrchestrateRequest<SearchResults<T>>	getPrev() The Request for fetching the prev page of the search results.
java.lang.Iterable<Result<T>>	getResults() Returns the search results for this request.
int	getTotalCount() Returns the total count of search results.
boolean	hasNext() Whether there is a URL for the next page of the search results.
boolean	hasPrev() Whether there is a URL for the prev page of the search results.
java.util.Iterator<Result<T>>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getResults

public final java.lang.Iterable<Result<T>> getResults()

Returns the search results for this request.

Returns:

The search results.

getAggregates

public final java.lang.Iterable<AggregateResult> getAggregates()

Returns the aggregate results associated with these search results.

Returns:

The aggregate results.

getCount

public final int getCount()

Returns the number of search results.

Returns:

The number of search results.

getTotalCount

public final int getTotalCount()

Returns the total count of search results.

Returns:

The total number of results for the query.

iterator

public final java.util.Iterator<Result<T>> iterator()

Specified by:

iterator in interface java.lang.Iterable<Result<T>>

getNext

public OrchestrateRequest<SearchResults<T>> getNext()

The Request for fetching the next page of the search results.

Returns:

The OrchestrateRequest that will fetch the next page of search results.

hasNext

public boolean hasNext()

Whether there is a URL for the next page of the search results.

Returns:

The URL of the next page of search results.

getPrev

public OrchestrateRequest<SearchResults<T>> getPrev()

The Request for fetching the prev page of the search results.

Returns:

The OrchestrateRequest that will fetch the prev page of search results.

hasPrev

public boolean hasPrev()

Whether there is a URL for the prev page of the search results.

Returns:

The URL of the prev page of search results.