org.hibernate.search.engine.search.query

Interface SearchQuery<H>

Type Parameters:

H - The type of query hits.

All Superinterfaces:

SearchFetchable<H>

All Known Subinterfaces:

ExtendedSearchQuery<H,R>, SearchQueryImplementor<H>

All Known Implementing Classes:

AbstractSearchQuery

public interface SearchQuery<H>
extends SearchFetchable<H>

A search query, allowing to fetch search results.

Method Summary

Modifier and Type	Method and Description
<Q> Q	extension(SearchQueryExtension<Q,H> extension) Extend the current query with the given extension, resulting in an extended query offering more options or a more detailed result type.
default String	getQueryString() Deprecated. Use queryString() instead.
String	queryString()

Methods inherited from interface org.hibernate.search.engine.search.query.SearchFetchable

fetch, fetch, fetchAll, fetchAllHits, fetchHits, fetchHits, fetchSingleHit, fetchTotalHitCount

Method Detail

queryString

String queryString()

Returns:

A textual representation of the query.

getQueryString

@Deprecated
default String getQueryString()

Deprecated. Use queryString() instead.

Returns:

A textual representation of the query.

extension

<Q> Q extension(SearchQueryExtension<Q,H> extension)

Extend the current query with the given extension, resulting in an extended query offering more options or a more detailed result type.

Type Parameters:

Q - The type of queries provided by the extension.

Parameters:

extension - The extension to the predicate DSL.

Returns:

The extended query.

Throws:

SearchException - If the extension cannot be applied (wrong underlying backend, ...).