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

Class AbstractSearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>,AF extends TypedSearchAggregationFactory<SR>,SC extends SearchQueryIndexScope<SR,?>>

java.lang.Object

org.hibernate.search.engine.search.query.dsl.spi.AbstractSearchQueryOptionsStep<SR,S,H,LOS,PDF,SF,AF,SC>

All Implemented Interfaces:

SearchQueryFinalStep<H>, SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>, SearchQueryWhereStep<SR,S,H,LOS,PDF>, SearchFetchable<H>

Direct Known Subclasses:

AbstractExtendedSearchQueryOptionsStep

public abstract class AbstractSearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>,AF extends TypedSearchAggregationFactory<SR>,SC extends SearchQueryIndexScope<SR,?>>
extends Object
implements SearchQueryWhereStep<SR,S,H,LOS,PDF>, SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>

Field Summary

Fields

Modifier and Type	Field	Description
protected final SC	scope

Constructor Summary

Constructors

Constructor	Description
AbstractSearchQueryOptionsStep(SC scope, SearchQueryBuilder<H> searchQueryBuilder, SearchLoadingContextBuilder<?,LOS> loadingContextBuilder)

Method Summary

Modifier and Type	Method	Description
<A> S	aggregation(AggregationKey<A> key, Function<? super AF,? extends AggregationFinalStep<A>> aggregationContributor)	Add an aggregation to this query.
<A> S	aggregation(AggregationKey<A> key, SearchAggregation<A> aggregation)	Add an aggregation to this query.
protected abstract AF	aggregationFactory()
S	failAfter(long timeout, TimeUnit timeUnit)	Stop the query and throw a SearchTimeoutException after a given timeout.
SearchResult<H>	fetch(Integer limit)	Execute the query and return the SearchResult, limiting to limit hits.
SearchResult<H>	fetch(Integer offset, Integer limit)	Execute the query and return the SearchResult, skipping offset hits and limiting to limit hits.
SearchResult<H>	fetchAll()	Execute the query and return the SearchResult, including all hits, without any sort of limit.
List<H>	fetchAllHits()	Execute the query and return all hits as a List, without any sort of limit.
List<H>	fetchHits(Integer limit)	Execute the query and return the hits as a List, limiting to limit hits.
List<H>	fetchHits(Integer offset, Integer limit)	Execute the query and return the hits as a List, skipping offset hits and limiting to limit hits.
Optional<H>	fetchSingleHit()	Execute the query and return the hits as a single, optional element.
long	fetchTotalHitCount()	Execute the query and return the total hit count.
S	highlighter(String highlighterName, Function<? super SearchHighlighterFactory,? extends HighlighterFinalStep> highlighterContributor)	Configure a named highlighter.
S	highlighter(String highlighterName, SearchHighlighter highlighter)	Configure a named highlighter.
S	highlighter(Function<? super SearchHighlighterFactory,? extends HighlighterFinalStep> highlighterContributor)	Configure the default highlighter.
S	highlighter(SearchHighlighter highlighter)	Configure the default highlighter.
protected abstract SearchHighlighterFactory	highlighterFactory()
S	loading(Consumer<? super LOS> loadingOptionsContributor)	Configure entity loading for this query.
S	param(String parameterName, Object value)	Add query parameter.
protected abstract PDF	predicateFactory()
S	routing(String routingKey)	Configure routing of the search query.
S	routing(Collection<String> routingKeys)	Configure routing of the search query.
SearchScroll<H>	scroll(int chunkSize)	Execute the query continuously to deliver results in small chunks through a SearchScroll.
S	sort(Function<? super SF,? extends SortFinalStep> sortContributor)	Add a sort to this query.
S	sort(SearchSort sort)	Add a sort to this query.
protected abstract SF	sortFactory()
protected abstract S	thisAsS()
SearchQuery<H>	toQuery()	Create a SearchQuery instance matching the definition given in the previous DSL steps.
S	totalHitCountThreshold(long totalHitCountThreshold)	Allow Hibernate Search to return a lower-bound estimate of the total hit count if it exceeds totalHitCountThreshold.
S	truncateAfter(long timeout, TimeUnit timeUnit)	Stop the query and return truncated results after a given timeout.
S	where(BiConsumer<? super PDF,? super SimpleBooleanPredicateClausesCollector<SR,?>> predicateContributor)	Set the predicate for this query.
S	where(Function<? super PDF,? extends PredicateFinalStep> predicateContributor)	Set the predicate for this query.
S	where(SearchPredicate predicate)	Set the predicate for this query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

scope

protected final SC extends SearchQueryIndexScope<SR,?> scope

Constructor Details

AbstractSearchQueryOptionsStep

public AbstractSearchQueryOptionsStep(SC scope,
 SearchQueryBuilder<H> searchQueryBuilder,
 SearchLoadingContextBuilder<?,LOS> loadingContextBuilder)

Method Details

where

public S where(SearchPredicate predicate)

Description copied from interface: SearchQueryWhereStep

Set the predicate for this query.

Specified by:

where in interface SearchQueryWhereStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>>

Parameters:

predicate - A SearchPredicate object obtained from the search scope.

Returns:

The next step.

where

public S where(Function<? super PDF,? extends PredicateFinalStep> predicateContributor)

Description copied from interface: SearchQueryWhereStep

Set the predicate for this query.

Specified by:

where in interface SearchQueryWhereStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>>

Parameters:

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

Returns:

The next step.

where

public S where(BiConsumer<? super PDF,? super SimpleBooleanPredicateClausesCollector<SR,?>> predicateContributor)

Description copied from interface: SearchQueryWhereStep

Set the predicate for this query.

Specified by:

where in interface SearchQueryWhereStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>>

Parameters:

predicateContributor - A consumer that will use the factory passed in parameter to create predicates and add them as clauses to the collector passed in parameter. Should generally be a lambda expression. The resulting root predicate will have to match all clauses.

Returns:

The next step.

See Also:

• SimpleBooleanPredicateClausesCollector

routing

public S routing(String routingKey)

Description copied from interface: SearchQueryOptionsStep

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.

Specified by:

routing in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

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

Returns:

this, for method chaining.

routing

public S routing(Collection<String> routingKeys)

Description copied from interface: SearchQueryOptionsStep

Configure routing of the search query.

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

Specified by:

routing in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

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

Returns:

this, for method chaining.

truncateAfter

public S truncateAfter(long timeout,
 TimeUnit timeUnit)

Description copied from interface: SearchQueryOptionsStep

Stop the query and return truncated results after a given timeout.

The timeout is handled on a best effort basis: Hibernate Search will *try* to stop the query as soon as possible after the timeout.

Specified by:

truncateAfter in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

timeout - Timeout value.

timeUnit - Timeout unit.

Returns:

this, for method chaining.

failAfter

public S failAfter(long timeout,
 TimeUnit timeUnit)

Description copied from interface: SearchQueryOptionsStep

Stop the query and throw a SearchTimeoutException after a given timeout.

The timeout is handled on a best effort basis: Hibernate Search will *try* to stop the query as soon as possible after the timeout. However, this method is more likely to trigger an early stop than SearchQueryOptionsStep.truncateAfter(long, TimeUnit).

Specified by:

failAfter in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

timeout - Timeout value.

timeUnit - Timeout unit.

Returns:

this, for method chaining.

totalHitCountThreshold

public S totalHitCountThreshold(long totalHitCountThreshold)

Description copied from interface: SearchQueryOptionsStep

Allow Hibernate Search to return a lower-bound estimate of the total hit count if it exceeds totalHitCountThreshold.

Allowing Hibernate Search to return a lower-bound estimate of the total hit count can lead to significantly fewer index scans and yield significant performance improvements, in particular when sorting by score (the default) on a large result set.

Note this optimization has no effect when also requesting aggregations.

Specified by:

totalHitCountThreshold in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

totalHitCountThreshold - the value below which the hit count is always exact

Returns:

this, for method chaining.

See Also:

• SearchResultTotal

highlighter

public S highlighter(Function<? super SearchHighlighterFactory,? extends HighlighterFinalStep> highlighterContributor)

Description copied from interface: SearchQueryOptionsStep

Configure the default highlighter.

For specifying the fields to highlight see SearchProjectionFactory.highlight(String). For providing field-specific settings to override the ones set here see SearchQueryOptionsStep.highlighter(String, Function).

Backend specific defaults will be used if no configuration is provided.

Specified by:

highlighter in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

highlighterContributor - a function that will use a highlighter factory to configure the default highlighter for this query.

Returns:

this, for method chaining.

highlighter

public S highlighter(SearchHighlighter highlighter)

Description copied from interface: SearchQueryOptionsStep

Configure the default highlighter.

For specifying the fields to highlight see SearchProjectionFactory.highlight(String). For providing field-specific settings to override the ones set here see SearchQueryOptionsStep.highlighter(String, Function).

Backend specific defaults will be used if no configuration is provided.

Specified by:

highlighter in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

highlighter - a highlighter obtained from the search scope to be used as the default highlighter for this query.

Returns:

this, for method chaining.

highlighter

public S highlighter(String highlighterName,
 Function<? super SearchHighlighterFactory,? extends HighlighterFinalStep> highlighterContributor)

Description copied from interface: SearchQueryOptionsStep

Configure a named highlighter.

Named highlighters are to be referenced in highlight projections.

Named highlighters override the settings set by a default highlighter if such was configured for this query.

The highlighter type must be the same as the default highlighter's, if a default highlighter settings was configured for this query.

Specified by:

highlighter in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

highlighterName - name of the highlighter. Can be referenced when defining a highlight projection.

highlighterContributor - a function that will use a highlighter factory to configure the named highlighter.

Returns:

this, for method chaining.

See Also:

• SearchProjectionFactory.highlight(String)
• HighlightProjectionOptionsStep.highlighter(String)

highlighter

public S highlighter(String highlighterName,
 SearchHighlighter highlighter)

Description copied from interface: SearchQueryOptionsStep

Configure a named highlighter.

Named highlighters are to be referenced in highlight projections.

Named highlighters override the settings set by a default highlighter if such was configured for this query.

The highlighter type must be the same as the default highlighter's, if a default highlighter settings was configured for this query.

Specified by:

highlighter in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

highlighterName - name of the highlighter. Can be referenced when defining a highlight projection.

highlighter - a highlighter obtained from the search scope that will serve as the named highlighter.

Returns:

this, for method chaining.

See Also:

• SearchProjectionFactory.highlight(String)
• HighlightProjectionOptionsStep.highlighter(String)

loading

public S loading(Consumer<? super LOS> loadingOptionsContributor)

Description copied from interface: SearchQueryOptionsStep

Configure entity loading for this query.

Specified by:

loading in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

loadingOptionsContributor - A consumer that will alter the loading options passed in parameter. Should generally be a lambda expression.

Returns:

this, for method chaining.

sort

public S sort(SearchSort sort)

Description copied from interface: SearchQueryOptionsStep

Add a sort to this query.

Specified by:

sort in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

sort - A SearchSort object obtained from the search scope.

Returns:

this, for method chaining.

sort

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

Description copied from interface: SearchQueryOptionsStep

Add a sort to this query.

Specified by:

sort in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

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.

aggregation

public <A> S aggregation(AggregationKey<A> key,
 SearchAggregation<A> aggregation)

Description copied from interface: SearchQueryOptionsStep

Add an aggregation to this query.

Specified by:

aggregation in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Type Parameters:

A - The type of aggregation values.

Parameters:

key - The key that will be used to retrieve the aggregation from the SearchResult.

aggregation - A SearchAggregation object obtained from the search scope.

Returns:

this, for method chaining.

aggregation

public <A> S aggregation(AggregationKey<A> key,
 Function<? super AF,? extends AggregationFinalStep<A>> aggregationContributor)

Description copied from interface: SearchQueryOptionsStep

Add an aggregation to this query.

Specified by:

aggregation in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Type Parameters:

A - The type of aggregation values.

Parameters:

key - The key that will be used to retrieve the aggregation from the SearchResult.

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

Returns:

this, for method chaining.

param

public S param(String parameterName,
 Object value)

Description copied from interface: SearchQueryOptionsStep

Add query parameter.

Query parameters are intended to use in various withParameters(..) to create projections/predicates/sorts/aggregations relying on these query parameters.

Specified by:

param in interface SearchQueryOptionsStep<SR,S extends SearchQueryOptionsStep<SR,S,H,LOS,SF,AF>,H,LOS,PDF extends TypedSearchPredicateFactory<SR>,SF extends TypedSearchSortFactory<SR>>

Parameters:

parameterName - The name of a query parameter.

value - The value of a query parameter.

Returns:

this, for method chaining.

toQuery

public SearchQuery<H> toQuery()

Description copied from interface: SearchQueryFinalStep

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().

Specified by:

toQuery in interface SearchQueryFinalStep<SR>

Returns:

The SearchQuery resulting from the previous DSL steps.

fetchAll

public SearchResult<H> fetchAll()

Description copied from interface: SearchFetchable

Execute the query and return the SearchResult, including all hits, without any sort of limit.

SearchFetchable.fetch(Integer) or SearchFetchable.fetch(Integer, Integer) should generally be preferred, for performance reasons.

Specified by:

fetchAll in interface SearchFetchable<SR>

Returns:

The SearchResult.

fetch

public SearchResult<H> fetch(Integer limit)

Description copied from interface: SearchFetchable

Execute the query and return the SearchResult, limiting to limit hits.

Specified by:

fetch in interface SearchFetchable<SR>

Parameters:

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

Returns:

The SearchResult.

fetch

public SearchResult<H> fetch(Integer offset,
 Integer limit)

Description copied from interface: SearchFetchable

Execute the query and return the SearchResult, skipping offset hits and limiting to limit hits.

Specified by:

fetch in interface SearchFetchable<SR>

Parameters:

offset - The number of hits to skip before adding the hits to the SearchResult. null means no offset.

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

Returns:

The SearchResult.

fetchAllHits

public List<H> fetchAllHits()

Description copied from interface: SearchFetchable

Execute the query and return all hits as a List, without any sort of limit.

SearchFetchable.fetchHits(Integer) or SearchFetchable.fetchHits(Integer, Integer) should generally be preferred, for performance reasons.

Specified by:

fetchAllHits in interface SearchFetchable<SR>

Returns:

The query hits.

fetchHits

public List<H> fetchHits(Integer limit)

Description copied from interface: SearchFetchable

Execute the query and return the hits as a List, limiting to limit hits.

Specified by:

fetchHits in interface SearchFetchable<SR>

Parameters:

limit - The maximum number of hits to be returned by this method. null means no limit.

Returns:

The query hits.

fetchHits

public List<H> fetchHits(Integer offset,
 Integer limit)

Description copied from interface: SearchFetchable

Execute the query and return the hits as a List, skipping offset hits and limiting to limit hits.

Specified by:

fetchHits in interface SearchFetchable<SR>

Parameters:

offset - The number of hits to skip. null means no offset.

limit - The maximum number of hits to be returned by this method. null means no limit.

Returns:

The query hits.

fetchSingleHit

public Optional<H> fetchSingleHit()

Description copied from interface: SearchFetchable

Execute the query and return the hits as a single, optional element.

Specified by:

fetchSingleHit in interface SearchFetchable<SR>

Returns:

The single, optional query hit.

fetchTotalHitCount

public long fetchTotalHitCount()

Description copied from interface: SearchFetchable

Execute the query and return the total hit count.

Specified by:

fetchTotalHitCount in interface SearchFetchable<SR>

Returns:

The total number of matching entities, ignoring pagination settings.

scroll

public SearchScroll<H> scroll(int chunkSize)

Description copied from interface: SearchFetchable

Execute the query continuously to deliver results in small chunks through a SearchScroll.

Useful to process large datasets.

Specified by:

scroll in interface SearchFetchable<SR>

Parameters:

chunkSize - The maximum number of hits to be returned for each call to SearchScroll.next()

Returns:

The SearchScroll.

thisAsS

protected abstract S thisAsS()

predicateFactory

protected abstract PDF predicateFactory()

sortFactory

protected abstract SF sortFactory()

aggregationFactory

protected abstract AF aggregationFactory()

highlighterFactory

protected abstract SearchHighlighterFactory highlighterFactory()