AbstractSearchQueryContext (Hibernate Search Engine 6.0.0.Alpha7 API)

java.lang.Object
- org.hibernate.search.engine.search.dsl.query.spi.AbstractSearchQueryContext<S,H,PDC,SC,C>

All Implemented Interfaces:: SearchQueryContext<S,H,SC>, SearchQueryResultContext<S,H,PDC>, SearchFetchable<H>

Direct Known Subclasses:: AbstractExtendedSearchQueryContext

public abstract class AbstractSearchQueryContext<S extends SearchQueryContext<S,H,SC>,H,PDC extends SearchPredicateFactoryContext,SC extends SearchSortFactoryContext,C>
extends Object
implements SearchQueryResultContext<S,H,PDC>, SearchQueryContext<S,H,SC>

Constructor Summary

Constructors
Constructor and Description

AbstractSearchQueryContext(IndexScope<C> indexScope, SearchQueryBuilder<H,C> searchQueryBuilder)

Constructors
Constructor and Description
`AbstractSearchQueryContext(IndexScope<C> indexScope, SearchQueryBuilder<H,C> searchQueryBuilder)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract PDC`	`extendPredicateContext(SearchPredicateFactoryContext predicateFactoryContext)`
`protected abstract SC`	`extendSortContext(SearchSortFactoryContext sortFactoryContext)`
`SearchResult<H>`	`fetch()` Execute the query and return the `SearchResult`.
`SearchResult<H>`	`fetch(Integer limit)` Execute the query and return the `SearchResult`.
`SearchResult<H>`	`fetch(Integer limit, Integer offset)` Execute the query and return the `SearchResult`.
`List<H>`	`fetchHits()` Execute the query and return the hits as a `List`.
`List<H>`	`fetchHits(Integer limit)` Execute the query and return the hits as a `List`.
`List<H>`	`fetchHits(Integer limit, Integer offset)` Execute the query and return the hits as a `List`.
`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`	`predicate(Function<? super PDC,? extends SearchPredicateTerminalContext> 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 SC,? extends SearchSortTerminalContext> sortContributor)` Add a sort to this query.
`S`	`sort(SearchSort sort)` Add a sort to this query.
`protected abstract S`	`thisAsS()`
`SearchQuery<H>`	`toQuery()`

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

- Constructor Detail
  - AbstractSearchQueryContext
```
public AbstractSearchQueryContext(IndexScope<C> indexScope,
                                  SearchQueryBuilder<H,C> searchQueryBuilder)
```
- Method Detail
  - predicate
```
public S predicate(SearchPredicate predicate)
```
    Description copied from interface: SearchQueryResultContext
    
    Set the predicate for this query.
    
    Specified by:
    
    predicate in interface SearchQueryResultContext<S extends SearchQueryContext<S,H,SC>,H,PDC extends SearchPredicateFactoryContext>
    
    Parameters:
    
    predicate - A SearchPredicate object obtained from the search scope.
    
    Returns:
    
    A context allowing to define the query further.
  - predicate
```
public S predicate(Function<? super PDC,? extends SearchPredicateTerminalContext> predicateContributor)
```
    Description copied from interface: SearchQueryResultContext
    
    Set the predicate for this query.
    
    Specified by:
    
    predicate in interface SearchQueryResultContext<S extends SearchQueryContext<S,H,SC>,H,PDC extends SearchPredicateFactoryContext>
    
    Parameters:
    
    predicateContributor - A function that will use the DSL context passed in parameter to create a predicate, returning the resulting terminal context. Should generally be a lambda expression.
    
    Returns:
    
    A context allowing to define the query further.
  - routing
```
public S routing(String routingKey)
```
    Description copied from interface: SearchQueryContext
    
    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 SearchQueryContext<S extends SearchQueryContext<S,H,SC>,H,SC extends SearchSortFactoryContext>
    
    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: SearchQueryContext
    
    Configure routing of the search query.
    Similar to SearchQueryContext.routing(String), but allows passing multiple keys in a single call.
    
    Specified by:
    
    routing in interface SearchQueryContext<S extends SearchQueryContext<S,H,SC>,H,SC extends SearchSortFactoryContext>
    
    Parameters:
    
    routingKeys - A collection containing zero, one or multiple string keys.
    
    Returns:
    
    this, for method chaining.
  - sort
```
public S sort(SearchSort sort)
```
    Description copied from interface: SearchQueryContext
    
    Add a sort to this query.
    
    Specified by:
    
    sort in interface SearchQueryContext<S extends SearchQueryContext<S,H,SC>,H,SC extends SearchSortFactoryContext>
    
    Parameters:
    
    sort - A SearchSort object obtained from the search scope.
    
    Returns:
    
    this, for method chaining.
  - sort
```
public S sort(Function<? super SC,? extends SearchSortTerminalContext> sortContributor)
```
    Description copied from interface: SearchQueryContext
    
    Add a sort to this query.
    
    Specified by:
    
    sort in interface SearchQueryContext<S extends SearchQueryContext<S,H,SC>,H,SC extends SearchSortFactoryContext>
    
    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
```
public SearchQuery<H> toQuery()
```
    Specified by:
    
    toQuery in interface SearchQueryContext<S extends SearchQueryContext<S,H,SC>,H,SC extends SearchSortFactoryContext>
  - fetch
```
public SearchResult<H> fetch()
```
    Description copied from interface: SearchFetchable
    
    Execute the query and return the SearchResult.
    
    Specified by:
    
    fetch 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.
    
    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 limit,
                             Integer offset)
```
    Description copied from interface: SearchFetchable
    
    Execute the query and return the SearchResult.
    
    Specified by:
    
    fetch in interface SearchFetchable<H>
    
    Parameters:
    
    limit - The maximum number of hits to be included in the SearchResult. null means no limit.
    
    offset - The number of hits to skip before adding the hits to the SearchResult. null means no offset.
    
    Returns:
    
    The SearchResult.
  - fetchHits
```
public List<H> fetchHits()
```
    Description copied from interface: SearchFetchable
    
    Execute the query and return the hits as a List.
    
    Specified by:
    
    fetchHits 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.
    
    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 limit,
                         Integer offset)
```
    Description copied from interface: SearchFetchable
    
    Execute the query and return the hits as a List.
    
    Specified by:
    
    fetchHits in interface SearchFetchable<H>
    
    Parameters:
    
    limit - The maximum number of hits to be returned by this method. null means no limit.
    
    offset - The number of hits to skip. null means no offset.
    
    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()
```
  - extendPredicateContext
```
protected abstract PDC extendPredicateContext(SearchPredicateFactoryContext predicateFactoryContext)
```
  - extendSortContext
```
protected abstract SC extendSortContext(SearchSortFactoryContext sortFactoryContext)
```

Class AbstractSearchQueryContext<S extends SearchQueryContext<S,H,SC>,H,PDC extends SearchPredicateFactoryContext,SC extends SearchSortFactoryContext,C>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractSearchQueryContext

Method Detail

predicate

predicate

routing

routing

sort

sort

toQuery

fetch

fetch

fetch

fetchHits

fetchHits

fetchHits

fetchSingleHit

fetchTotalHitCount

thisAsS

extendPredicateContext

extendSortContext