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

Interface SearchQueryContext<S extends SearchQueryContext<? extends S,H,SC>,H,SC extends SearchSortFactoryContext>

Type Parameters:

S - The type actually exposed to the user for this context (may be a subtype of SearchQueryContext, with more exposed methods).

H - The type of hits for the created query.

SC - The type of contexts used to create sorts in sort(Function).

All Superinterfaces:

SearchFetchable<H>

All Known Implementing Classes:

AbstractExtendedSearchQueryContext, AbstractSearchQueryContext

public interface SearchQueryContext<S extends SearchQueryContext<? extends S,H,SC>,H,SC extends SearchSortFactoryContext>
extends SearchFetchable<H>

The context used when building a query, after the search predicate has been defined.

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 SC,? extends SearchSortTerminalContext> sortContributor) Add a sort to this query.
S	sort(SearchSort sort) Add a sort to this query.
SearchQuery<H>	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 SC,? extends SearchSortTerminalContext> sortContributor)

Add a sort to this query.

Parameters:

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

Returns:

this, for method chaining.

toQuery

SearchQuery<H> toQuery()