org.hibernate.search.engine.search.query

Interface SearchFetchable<H>

Type Parameters:

H - The type of query hits.

All Known Subinterfaces:

ExtendedSearchFetchable<H,R>, ExtendedSearchQuery<H,R>, SearchQuery<H>, SearchQueryContext<S,H,SC>

All Known Implementing Classes:

AbstractExtendedSearchQueryContext, AbstractSearchQuery, AbstractSearchQueryContext

public interface SearchFetchable<H>

A component allowing to fetch search results.

Method Summary

Modifier and Type	Method and Description
SearchResult<H>	fetch() Execute the query and return the SearchResult.
SearchResult<H>	fetch(Integer limit) Execute the query and return the SearchResult.
SearchResult<H>	fetch(Integer limit, Integer offset) Execute the query and return the SearchResult.
List<H>	fetchHits() Execute the query and return the hits as a List.
List<H>	fetchHits(Integer limit) Execute the query and return the hits as a List.
List<H>	fetchHits(Integer limit, Integer offset) Execute the query and return the hits as a List.
Optional<H>	fetchSingleHit() Execute the query and return the hits as a single, optional element.
long	fetchTotalHitCount() Execute the query and return the total hit count.

Method Detail

fetch

SearchResult<H> fetch()

Execute the query and return the SearchResult.

Returns:

The SearchResult.

Throws:

SearchException - If something goes wrong while executing the query.

RuntimeException - If something goes wrong while loading entities. The exact type depends on the mapper, e.g. HibernateException/PersistenceException for the Hibernate ORM mapper.

fetch

SearchResult<H> fetch(Integer limit)

Execute the query and return the SearchResult.

Parameters:

limit - The maximum number of hits to be included in the SearchResult. null means no limit.

Returns:

The SearchResult.

Throws:

SearchException - If something goes wrong while executing the query.

RuntimeException - If something goes wrong while loading entities. The exact type depends on the mapper, e.g. HibernateException/PersistenceException for the Hibernate ORM mapper.

fetch

SearchResult<H> fetch(Integer limit,
                      Integer offset)

Execute the query and return the SearchResult.

Parameters:

limit - The maximum number of hits to be included in the SearchResult. null means no limit.

offset - The number of hits to skip before adding the hits to the SearchResult. null means no offset.

Returns:

The SearchResult.

Throws:

SearchException - If something goes wrong while executing the query.

RuntimeException - If something goes wrong while loading entities. The exact type depends on the mapper, e.g. HibernateException/PersistenceException for the Hibernate ORM mapper.

fetchHits

List<H> fetchHits()

Execute the query and return the hits as a List.

Returns:

The query hits.

Throws:

SearchException - If something goes wrong while executing the query.

RuntimeException - If something goes wrong while loading entities. The exact type depends on the mapper, e.g. HibernateException/PersistenceException for the Hibernate ORM mapper.

fetchHits

List<H> fetchHits(Integer limit)

Execute the query and return the hits as a List.

Parameters:

limit - The maximum number of hits to be returned by this method. null means no limit.

Returns:

The query hits.

Throws:

SearchException - If something goes wrong while executing the query.

RuntimeException - If something goes wrong while loading entities. The exact type depends on the mapper, e.g. HibernateException/PersistenceException for the Hibernate ORM mapper.

fetchHits

List<H> fetchHits(Integer limit,
                  Integer offset)

Execute the query and return the hits as a List.

Parameters:

limit - The maximum number of hits to be returned by this method. null means no limit.

offset - The number of hits to skip. null means no offset.

Returns:

The query hits.

Throws:

SearchException - If something goes wrong while executing the query.

RuntimeException - If something goes wrong while loading entities. The exact type depends on the mapper, e.g. HibernateException/PersistenceException for the Hibernate ORM mapper.

fetchSingleHit

Optional<H> fetchSingleHit()

Execute the query and return the hits as a single, optional element.

Returns:

The single, optional query hit.

Throws:

SearchException - If something goes wrong while executing the query, or the number of hits is more than one.

RuntimeException - If something goes wrong while loading entities. The exact type depends on the mapper, e.g. HibernateException/PersistenceException for the Hibernate ORM mapper.

fetchTotalHitCount

long fetchTotalHitCount()

Execute the query and return the total hit count.

Returns:

The total number of matching entities, ignoring pagination settings.

Throws:

SearchException - If something goes wrong while executing the query.