org.hibernate.search.engine.search.query

Interface SearchResult<H>

Type Parameters:

H - The type of hits.

All Known Implementing Classes:

SimpleSearchResult

public interface SearchResult<H>

Method Summary

Modifier and Type	Method and Description
<A> A	getAggregation(AggregationKey<A> key)
List<H>	getHits()
Duration	getTook()
long	getTotalHitCount()
boolean	isTimedOut()

Method Detail

getTotalHitCount

long getTotalHitCount()

Returns:

The total number of matching entities, ignoring pagination settings.

getHits

List<H> getHits()

Returns:

The hits as a List containing one element for each matched entity.

getAggregation

<A> A getAggregation(AggregationKey<A> key)

Type Parameters:

A - The type of result for this aggregation.

Parameters:

key - The key previously used to register the aggregation during query building.

Returns:

The result for the given aggregation.

Throws:

SearchException - If the given key was never registered while building this query, and is thus not mapped to anything.

getTook

Duration getTook()

Returns:

the time taken to process the request, as a Duration

isTimedOut

boolean isTimedOut()

Returns:

whether or not a timeout occurred processing the request.