AbstractSearchQueryOptionsStep (Hibernate Search Engine 6.0.0.Beta4 API)

java.lang.Object
- org.hibernate.search.engine.search.query.dsl.spi.AbstractSearchQueryOptionsStep<S,H,LOS,PDF,SF,AF,C>

All Implemented Interfaces:: SearchQueryFinalStep<H>, SearchQueryOptionsStep<S,H,LOS,SF,AF>, SearchQueryPredicateStep<S,H,PDF>, SearchFetchable<H>

Direct Known Subclasses:: AbstractExtendedSearchQueryOptionsStep

public abstract class AbstractSearchQueryOptionsStep<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,PDF extends SearchPredicateFactory,SF extends SearchSortFactory,AF extends SearchAggregationFactory,C>
extends Object
implements SearchQueryPredicateStep<S,H,PDF>, SearchQueryOptionsStep<S,H,LOS,SF,AF>

Constructor Summary

Constructors
Constructor and Description
`AbstractSearchQueryOptionsStep(IndexScope<C> indexScope, SearchQueryBuilder<H,C> searchQueryBuilder, LoadingContextBuilder<?,?,LOS> loadingContextBuilder)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and 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`	`extendAggregationFactory(SearchAggregationFactory aggregationFactory)`
`protected abstract PDF`	`extendPredicateFactory(SearchPredicateFactory predicateFactory)`
`protected abstract SF`	`extendSortFactory(SearchSortFactory sortFactory)`
`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`	`loading(Consumer<? super LOS> loadingOptionsContributor)` Configure entity loading for this query.
`S`	`predicate(Function<? super PDF,? extends PredicateFinalStep> predicateContributor)` Set the predicate for this query.
`S`	`predicate(SearchPredicate predicate)` Set the predicate for this query.
`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.
`protected abstract S`	`thisAsS()`
`SearchQuery<H>`	`toQuery()` Create a `SearchQuery` instance matching the definition given in the previous DSL steps.
`S`	`truncateAfter(long timeout, TimeUnit timeUnit)` Stop the query and return truncated results after a given timeout.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractSearchQueryOptionsStep
```
public AbstractSearchQueryOptionsStep(IndexScope<C> indexScope,
                                      SearchQueryBuilder<H,C> searchQueryBuilder,
                                      LoadingContextBuilder<?,?,LOS> loadingContextBuilder)
```
- Method Detail
  - predicate
```
public S predicate(SearchPredicate predicate)
```
    Description copied from interface: SearchQueryPredicateStep
    
    Set the predicate for this query.
    
    Specified by:
    
    predicate in interface SearchQueryPredicateStep<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,PDF extends SearchPredicateFactory>
    
    Parameters:
    
    predicate - A SearchPredicate object obtained from the search scope.
    
    Returns:
    
    The next step.
  - predicate
```
public S predicate(Function<? super PDF,? extends PredicateFinalStep> predicateContributor)
```
    Description copied from interface: SearchQueryPredicateStep
    
    Set the predicate for this query.
    
    Specified by:
    
    predicate in interface SearchQueryPredicateStep<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,PDF extends SearchPredicateFactory>
    
    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.
  - 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<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,SF extends SearchSortFactory,AF extends SearchAggregationFactory>
    
    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<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,SF extends SearchSortFactory,AF extends SearchAggregationFactory>
    
    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<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,SF extends SearchSortFactory,AF extends SearchAggregationFactory>
    
    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<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,SF extends SearchSortFactory,AF extends SearchAggregationFactory>
    
    Parameters:
    
    timeout - Timeout value.
    
    timeUnit - Timeout unit.
    
    Returns:
    
    this, for method chaining.
  - 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<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,SF extends SearchSortFactory,AF extends SearchAggregationFactory>
    
    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<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,SF extends SearchSortFactory,AF extends SearchAggregationFactory>
    
    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<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,SF extends SearchSortFactory,AF extends SearchAggregationFactory>
    
    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<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,SF extends SearchSortFactory,AF extends SearchAggregationFactory>
    
    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<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,SF extends SearchSortFactory,AF extends SearchAggregationFactory>
    
    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.
  - 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<H>
    
    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<H>
    
    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<H>
    
    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<H>
    
    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<H>
    
    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<H>
    
    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<H>
    
    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<H>
    
    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<H>
    
    Returns:
    
    The total number of matching entities, ignoring pagination settings.
  - thisAsS
```
protected abstract S thisAsS()
```
  - extendPredicateFactory
```
protected abstract PDF extendPredicateFactory(SearchPredicateFactory predicateFactory)
```
  - extendSortFactory
```
protected abstract SF extendSortFactory(SearchSortFactory sortFactory)
```
  - extendAggregationFactory
```
protected abstract AF extendAggregationFactory(SearchAggregationFactory aggregationFactory)
```

Class AbstractSearchQueryOptionsStep<S extends SearchQueryOptionsStep<S,H,LOS,SF,AF>,H,LOS,PDF extends SearchPredicateFactory,SF extends SearchSortFactory,AF extends SearchAggregationFactory,C>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractSearchQueryOptionsStep

Method Detail

predicate

predicate

routing

routing

truncateAfter

failAfter

loading

sort

sort

aggregation

aggregation

toQuery

fetchAll

fetch

fetch

fetchAllHits

fetchHits

fetchHits

fetchSingleHit

fetchTotalHitCount

thisAsS

extendPredicateFactory

extendSortFactory

extendAggregationFactory