Package org.hibernate.search.engine.search.query.dsl

Interface SearchQueryFinalStep<H>

Type Parameters:

H - The type of hits for the created query.

All Superinterfaces:

SearchFetchable<H>

All Known Subinterfaces:

ElasticsearchSearchQueryOptionsStep<H,LOS>, LuceneSearchQueryOptionsStep<H,LOS>, SearchQueryOptionsStep<S,H,LOS,SF,AF>

All Known Implementing Classes:

AbstractExtendedSearchQueryOptionsStep, AbstractSearchQueryOptionsStep

public interface SearchQueryFinalStep<H>
extends SearchFetchable<H>

The final step in a query definition, where the query can be executed or retrieved as an object.

Method Summary

Modifier and Type	Method	Description
SearchQuery<H>	toQuery()	Create a SearchQuery instance matching the definition given in the previous DSL steps.

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

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

Method Details

toQuery

SearchQuery<H> toQuery()

Create a SearchQuery instance matching the definition given in the previous DSL steps.

Calling this method is generally not necessary as most query execution methods are also implemented by this DSL step, so for example .toQuery().fetch() can be replaced with simply .fetch().

Returns:

The SearchQuery resulting from the previous DSL steps.