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

Interface SearchQueryOptionsStep<S extends SearchQueryOptionsStep<? extends S,H,SF>,H,SF extends SearchSortFactory>

Type Parameters:

S - The "self" type (the actual exposed type of this step). May be a subtype of SearchQueryOptionsStep with more exposed methods.

H - The type of hits for the created query.

SF - The type of factory used to create sorts in sort(Function).

All Superinterfaces:

SearchFetchable<H>, SearchQueryFinalStep<H>

All Known Implementing Classes:

AbstractExtendedSearchQueryOptionsStep, AbstractSearchQueryOptionsStep

public interface SearchQueryOptionsStep<S extends SearchQueryOptionsStep<? extends S,H,SF>,H,SF extends SearchSortFactory>
extends SearchQueryFinalStep<H>, SearchFetchable<H>

The final step in a query definition, where optional parameters such as sorts can be set, and where the query can be executed or retrieved as an object.

Method Summary

Modifier and Type	Method and Description
S	routing(Collection<String> routingKeys) Configure routing of the search query.
S	routing(String routingKey) Configure routing of the search query.
S	sort(Function<? super SF,? extends SortFinalStep> sortContributor) Add a sort to this query.
S	sort(SearchSort sort) Add a sort to this query.

Methods inherited from interface org.hibernate.search.engine.search.dsl.query.SearchQueryFinalStep

toQuery

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

fetch, fetch, fetch, fetchHits, fetchHits, fetchHits, fetchSingleHit, fetchTotalHitCount

Method Detail

routing

S routing(String routingKey)

Configure routing of the search query.

Useful when indexes are sharded, to limit the number of shards interrogated by the search query.

This method may be called multiple times, in which case all submitted routing keys will be taken into account.

By default, if routing is not configured, all shards will be queried.

Parameters:

routingKey - A string key. All shards matching this key will be queried.

Returns:

this, for method chaining.

routing

S routing(Collection<String> routingKeys)

Configure routing of the search query.

Similar to routing(String), but allows passing multiple keys in a single call.

Parameters:

routingKeys - A collection containing zero, one or multiple string keys.

Returns:

this, for method chaining.

sort

S sort(SearchSort sort)

Add a sort to this query.

Parameters:

sort - A SearchSort object obtained from the search scope.

Returns:

this, for method chaining.

sort

S sort(Function<? super SF,? extends SortFinalStep> sortContributor)

Add a sort to this query.

Parameters:

sortContributor - A function that will use the factory passed in parameter to create a sort, returning the final step in the sort DSL. Should generally be a lambda expression.

Returns:

this, for method chaining.