org.hibernate.search.mapper.javabean.search.query

Interface SearchQuery<T>

Type Parameters:

T - The type of results.

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(int 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.
long	fetchTotalHitCount() Execute the query and return the total hit count.
String	getQueryString()

Method Detail

fetch

default SearchResult<T> fetch()

Execute the query and return the SearchResult.

Returns:

The SearchResult.

Throws:

org.hibernate.search.util.common.SearchException - If something goes wrong while executing the query.

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.

Returns:

The SearchResult.

Throws:

org.hibernate.search.util.common.SearchException - If something goes wrong while executing the query.

fetch

default SearchResult<T> fetch(int limit)

Execute the query and return the SearchResult.

Parameters:

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

Returns:

The SearchResult.

Throws:

org.hibernate.search.util.common.SearchException - If something goes wrong while executing the query.

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:

org.hibernate.search.util.common.SearchException - If something goes wrong while executing the query.

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:

org.hibernate.search.util.common.SearchException - If something goes wrong while executing the query.

fetchTotalHitCount

long fetchTotalHitCount()

Execute the query and return the total hit count.

Returns:

The total number of matching entities, ignoring pagination settings.

Throws:

org.hibernate.search.util.common.SearchException - If something goes wrong while executing the query.

getQueryString

String getQueryString()

Returns:

A textual representation of the query.