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

Interface SearchQueryResultDefinitionContext<N extends SearchQueryContext<?,E,?>,R,E,PJC extends SearchProjectionFactoryContext<R,E>,PDC extends SearchPredicateFactoryContext>

Type Parameters:

N - The next context if no type of hits is explicitly selected, i.e. if SearchQueryResultContext.predicate(SearchPredicate) or SearchQueryResultContext.predicate(Function) is called directly without calling asEntity(), or asEntityReference(), asProjection(SearchProjection) or a similar method.

R - The type of entity references, i.e. the type of hits returned by reference queries, or the type of objects returned for entity reference projections.

E - The type of entities, i.e. the type of hits returned by entity queries, or the type of objects returned for entity projections.

PJC - The type of contexts used to create projections in asProjection(Function).

PDC - The type of contexts used to create predicates in SearchQueryResultContext.predicate(Function).

All Superinterfaces:

SearchQueryResultContext<N,E,PDC>

All Known Implementing Classes:

AbstractDelegatingSearchQueryResultDefinitionContext, AbstractSearchQueryResultDefinitionContext

public interface SearchQueryResultDefinitionContext<N extends SearchQueryContext<?,E,?>,R,E,PJC extends SearchProjectionFactoryContext<R,E>,PDC extends SearchPredicateFactoryContext>
extends SearchQueryResultContext<N,E,PDC>

The context used when building a query, before the search result type has been defined.

Method Summary

Modifier and Type	Method and Description
SearchQueryResultContext<?,E,?>	asEntity() Define the query results as the entity was originally indexed, loaded from an external source (database, ...).
SearchQueryResultContext<?,R,?>	asEntityReference() Define the query results as a reference to the entity that was originally indexed.
<P> SearchQueryResultContext<?,P,?>	asProjection(Function<? super PJC,? extends SearchProjectionTerminalContext<P>> projectionContributor) Define the query results as one projection for each matching document.
<P> SearchQueryResultContext<?,P,?>	asProjection(SearchProjection<P> projection) Define the query results as one projection for each matching document.
SearchQueryResultContext<?,List<?>,?>	asProjections(SearchProjection<?>... projections) Define the query results as a list of projections for each matching document.
<T> T	extension(SearchQueryContextExtension<T,R,E> extension) Extend the current context with the given extension, resulting in an extended context offering more query options.

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

predicate, predicate

Method Detail

asEntity

SearchQueryResultContext<?,E,?> asEntity()

Define the query results as the entity was originally indexed, loaded from an external source (database, ...).

Returns:

A context allowing to define the query further.

See Also:

SearchQueryResultContext

asEntityReference

SearchQueryResultContext<?,R,?> asEntityReference()

Define the query results as a reference to the entity that was originally indexed.

Returns:

A context allowing to define the query further.

See Also:

SearchQueryResultContext

asProjection

<P> SearchQueryResultContext<?,P,?> asProjection(Function<? super PJC,? extends SearchProjectionTerminalContext<P>> projectionContributor)

Define the query results as one projection for each matching document.

Type Parameters:

P - The resulting type of the projection.

Parameters:

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

Returns:

A context allowing to define the query further.

See Also:

SearchQueryResultContext

asProjection

<P> SearchQueryResultContext<?,P,?> asProjection(SearchProjection<P> projection)

Define the query results as one projection for each matching document.

Type Parameters:

P - The resulting type of the projection.

Parameters:

projection - A previously-created SearchProjection object.

Returns:

A context allowing to define the query further.

See Also:

SearchQueryResultContext

asProjections

SearchQueryResultContext<?,List<?>,?> asProjections(SearchProjection<?>... projections)

Define the query results as a list of projections for each matching document.

Note that using this method will force you to use casts when consuming the results, since the returned lists are not typed (List<?> instead of List<T>). You can replace calls to this method advantageously with calls to asProjection(Function) defining a composite projection.

Parameters:

projections - A list of previously-created SearchProjection objects.

Returns:

A context allowing to define the query further.

See Also:

SearchProjectionFactoryContext.composite(BiFunction, SearchProjection, SearchProjection), SearchQueryResultContext

extension

<T> T extension(SearchQueryContextExtension<T,R,E> extension)

Extend the current context with the given extension, resulting in an extended context offering more query options.

Type Parameters:

T - The type of context provided by the extension.

Parameters:

extension - The extension to the predicate DSL.

Returns:

The extended context.

Throws:

SearchException - If the extension cannot be applied (wrong underlying backend, ...).