Package org.hibernate.search.engine.search.query.spi

Class SimpleSearchScrollResult<H>

java.lang.Object

org.hibernate.search.engine.search.query.spi.SimpleSearchScrollResult<H>

All Implemented Interfaces:

SearchScrollResult<H>

public class SimpleSearchScrollResult<H>
extends Object
implements SearchScrollResult<H>

Constructor Summary

Constructors

Constructor	Description
SimpleSearchScrollResult(SearchResultTotal resultTotal, boolean hasHits, List<H> hits, Duration took, Boolean timedOut)

Method Summary

Modifier and Type	Method	Description
boolean	hasHits()	Returns true if this scrolling result contains some index hits.
List<H>	hits()
boolean	timedOut()
Duration	took()
SearchResultTotal	total()

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleSearchScrollResult

public SimpleSearchScrollResult(SearchResultTotal resultTotal,
 boolean hasHits,
 List<H> hits,
 Duration took,
 Boolean timedOut)

Method Details

total

public SearchResultTotal total()

Specified by:

total in interface SearchScrollResult<H>

Returns:

The total for a search result, pertaining to all matched documents, independently from the current chunk of SearchScrollResult.hits(). Includes in particular the total hit count.

hasHits

public boolean hasHits()

Description copied from interface: SearchScrollResult

Returns true if this scrolling result contains some index hits.

Notice that it is possible for this method to return true while SearchScrollResult.hits() returns an empty list, e.g.: if matching entities could not be found in the database.

This methods is mainly useful as a stop condition in loops.

Specified by:

hasHits in interface SearchScrollResult<H>

Returns:

if there are still some index result hits.

hits

public List<H> hits()

Specified by:

hits in interface SearchScrollResult<H>

Returns:

The hits of this scrolling result as a List containing one element for each matched entity.

took

public Duration took()

Specified by:

took in interface SearchScrollResult<H>

Returns:

the time taken to process the request, as a Duration

timedOut

public boolean timedOut()

Specified by:

timedOut in interface SearchScrollResult<H>

Returns:

whether or not a timeout occurred processing the request.