org.hibernate.search.mapper.orm.search.query

Interface SearchQuery<T>

public interface SearchQuery<T>

Method Summary

Modifier and Type	Method and Description
default SearchResult<T>	fetch() Execute the query and return the SearchResult.
default SearchResult<T>	fetch(Integer limit) Execute the query and return the SearchResult.
default SearchResult<T>	fetch(Integer limit, Integer offset) Execute the query and return the SearchResult.
default SearchResult<T>	fetch(Long limit) Execute the query and return the SearchResult.
SearchResult<T>	fetch(Long limit, Long offset) Execute the query and return the SearchResult.
default List<T>	fetchHits() Execute the query and return the hits as a List.
default List<T>	fetchHits(Integer limit) Execute the query and return the hits as a List.
default List<T>	fetchHits(Integer limit, Integer offset) Execute the query and return the hits as a List.
default List<T>	fetchHits(Long limit) Execute the query and return the hits as a List.
List<T>	fetchHits(Long limit, Long offset) Execute the query and return the hits as a List.
Optional<T>	fetchSingleHit() Execute the query and return the hits as a single, optional element.
long	fetchTotalHitCount() Execute the query and return the total hit count.
SearchQuery<T>	setFetchSize(int fetchSize) Set the JDBC fetch size for this query.
TypedQuery<T>	toJpaQuery() Convert this query to a JPA query.
Query<T>	toOrmQuery() Convert this query to a Hibernate ORM query.

Method Detail

fetch

default SearchResult<T> fetch()

Execute the query and return the SearchResult.

Returns:

The SearchResult.

Throws:

SearchException - If something goes wrong while executing the query.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

fetch

default SearchResult<T> fetch(Long 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.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

fetch

default SearchResult<T> 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.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

fetch

SearchResult<T> fetch(Long limit,
                      Long 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.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

fetch

default SearchResult<T> 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.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

fetchHits

default List<T> 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.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

fetchHits

default List<T> fetchHits(Long 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.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

fetchHits

default List<T> 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.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

fetchHits

List<T> fetchHits(Long limit,
                  Long 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. null means no offset.

Returns:

The query hits.

Throws:

SearchException - If something goes wrong while executing the query.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

fetchHits

default List<T> 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. null means no offset.

Returns:

The query hits.

Throws:

SearchException - If something goes wrong while executing the query.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

fetchSingleHit

Optional<T> 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.

HibernateException - If something goes wrong while fetching entities from the database.

PersistenceException - If something goes wrong while fetching entities from the database.

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.

setFetchSize

SearchQuery<T> setFetchSize(int fetchSize)

Set the JDBC fetch size for this query.

Parameters:

fetchSize - The fetch size. Must be positive or zero.

Returns:

this for method chaining.

See Also:

Query.setFetchSize(int)

toJpaQuery

TypedQuery<T> toJpaQuery()

Convert this query to a JPA query.

Note that the resulting query does not support all operations and may behave slightly differently in some cases (including, but not limited to, the type of thrown exceptions). For these reasons, it is recommended to only use this method when integrating to an external library that expects JPA queries.

Returns:

A representation of this query as a JPA query.

toOrmQuery

Query<T> toOrmQuery()

Convert this query to a Hibernate ORM query.

Note that the resulting query does not support all operations and may behave slightly differently in some cases (including, but not limited to, the type of thrown exceptions). For these reasons, it is recommended to only use this method when integrating to an external library that expects Hibernate ORM queries.

Returns:

A representation of this query as a Hibernate ORM query.