org.hibernate.search.mapper.javabean.search.dsl.query

Interface SearchQueryResultDefinitionContext

public interface SearchQueryResultDefinitionContext

Method Summary

Modifier and Type	Method and Description
<T> org.hibernate.search.engine.search.dsl.query.SearchQueryResultContext<SearchQuery<T>>	asProjection(Function<? super org.hibernate.search.engine.search.dsl.projection.SearchProjectionFactoryContext<PojoReference,?>,? extends org.hibernate.search.engine.search.dsl.projection.SearchProjectionTerminalContext<T>> projectionContributor) Define the query results as one projection for each matching document.
<T> org.hibernate.search.engine.search.dsl.query.SearchQueryResultContext<SearchQuery<T>>	asProjection(org.hibernate.search.engine.search.SearchProjection<T> projection) Define the query results as one projection for each matching document.
org.hibernate.search.engine.search.dsl.query.SearchQueryResultContext<SearchQuery<List<?>>>	asProjections(org.hibernate.search.engine.search.SearchProjection<?>... projections) Define the query results as a list of projections for each matching document.
org.hibernate.search.engine.search.dsl.query.SearchQueryResultContext<SearchQuery<PojoReference>>	asReference() Define the query results as one PojoReference for each matching document.

Method Detail

asReference

org.hibernate.search.engine.search.dsl.query.SearchQueryResultContext<SearchQuery<PojoReference>> asReference()

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

Returns:

A context allowing to define the query further.

See Also:

SearchQueryResultContext

asProjection

<T> org.hibernate.search.engine.search.dsl.query.SearchQueryResultContext<SearchQuery<T>> asProjection(Function<? super org.hibernate.search.engine.search.dsl.projection.SearchProjectionFactoryContext<PojoReference,?>,? extends org.hibernate.search.engine.search.dsl.projection.SearchProjectionTerminalContext<T>> projectionContributor)

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

Type Parameters:

T - 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

<T> org.hibernate.search.engine.search.dsl.query.SearchQueryResultContext<SearchQuery<T>> asProjection(org.hibernate.search.engine.search.SearchProjection<T> projection)

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

Type Parameters:

T - The resulting type of the projection.

Parameters:

projection - A SearchProjection object obtained from the SearchScope.

Returns:

A context allowing to define the query further.

See Also:

SearchQueryResultContext

asProjections

org.hibernate.search.engine.search.dsl.query.SearchQueryResultContext<SearchQuery<List<?>>> asProjections(org.hibernate.search.engine.search.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 SearchProjection object obtained from the SearchScope.

Returns:

A context allowing to define the query further.

See Also:

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