org.hibernate.search.engine.search.dsl.projection

Interface SearchProjectionFactoryContext<R,E>

Type Parameters:

R - The type of references, i.e. the type of objects returned for reference projections.

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

All Known Implementing Classes:

DelegatingSearchProjectionFactoryContext

public interface SearchProjectionFactoryContext<R,E>

A context allowing to create a projection.

Method Summary

Modifier and Type	Method and Description
<P1,P2,T> CompositeProjectionContext<T>	composite(BiFunction<P1,P2,T> transformer, SearchProjection<P1> projection1, SearchProjection<P2> projection2) Create a projection that will compose a custom object based on two given projections.
default <P1,P2,T> CompositeProjectionContext<T>	composite(BiFunction<P1,P2,T> transformer, SearchProjectionTerminalContext<P1> terminalContext1, SearchProjectionTerminalContext<P2> terminalContext2) Create a projection that will compose a custom object based on two almost-built projections.
<T> CompositeProjectionContext<T>	composite(Function<List<?>,T> transformer, SearchProjection<?>... projections) Create a projection that will compose a custom object based on the given projections.
default <T> CompositeProjectionContext<T>	composite(Function<List<?>,T> transformer, SearchProjectionTerminalContext<?>... terminalContexts) Create a projection that will compose a custom object based on the given almost-built projections.
<P,T> CompositeProjectionContext<T>	composite(Function<P,T> transformer, SearchProjection<P> projection) Create a projection that will compose a custom object based on one given projection.
default <P,T> CompositeProjectionContext<T>	composite(Function<P,T> transformer, SearchProjectionTerminalContext<P> terminalContext) Create a projection that will compose a custom object based on one almost-built projection.
default CompositeProjectionContext<List<?>>	composite(SearchProjection<?>... projections) Create a projection that will compose a List based on the given projections.
default CompositeProjectionContext<List<?>>	composite(SearchProjectionTerminalContext<?>... terminalContexts) Create a projection that will compose a List based on the given almost-built projections.
<P1,P2,P3,T> CompositeProjectionContext<T>	composite(TriFunction<P1,P2,P3,T> transformer, SearchProjection<P1> projection1, SearchProjection<P2> projection2, SearchProjection<P3> projection3) Create a projection that will compose a custom object based on three given projections.
default <P1,P2,P3,T> CompositeProjectionContext<T>	composite(TriFunction<P1,P2,P3,T> transformer, SearchProjectionTerminalContext<P1> terminalContext1, SearchProjectionTerminalContext<P2> terminalContext2, SearchProjectionTerminalContext<P3> terminalContext3) Create a projection that will compose a custom object based on three almost-built projections.
DistanceToFieldProjectionContext	distance(String absoluteFieldPath, GeoPoint center) Project on the distance from the center to a GeoPoint field.
DocumentReferenceProjectionContext	documentReference() Project the match to a DocumentReference.
EntityProjectionContext<E>	entity() Project to an entity representing the match.
<T> SearchProjectionFactoryExtensionContext<T,R,E>	extension() Create a context allowing to try to apply multiple extensions one after the other, failing only if none of the extensions is supported.
<T> T	extension(SearchProjectionFactoryContextExtension<T,R,E> extension) Extend the current context with the given extension, resulting in an extended context offering different types of projections.
default FieldProjectionContext<Object>	field(String absoluteFieldPath) Project to the value of a field in the indexed document, without specifying a type.
default <T> FieldProjectionContext<T>	field(String absoluteFieldPath, Class<T> type) Project to the value of a field in the indexed document.
<T> FieldProjectionContext<T>	field(String absoluteFieldPath, Class<T> type, ProjectionConverter projectionConverter) Project to the value of a field in the indexed document.
FieldProjectionContext<Object>	field(String absoluteFieldPath, ProjectionConverter projectionConverter) Project to the value of a field in the indexed document, without specifying a type.
ReferenceProjectionContext<R>	reference() Project to a reference to the match.
ScoreProjectionContext	score() Project on the score of the hit.

Method Detail

documentReference

DocumentReferenceProjectionContext documentReference()

Project the match to a DocumentReference.

Returns:

A context allowing to define the projection more precisely.

reference

ReferenceProjectionContext<R> reference()

Project to a reference to the match.

The actual type of the reference depends on the mapper used to create the query: the ORM mapper will return a class/identifier pair, for example.

Returns:

A context allowing to define the projection more precisely.

entity

EntityProjectionContext<E> entity()

Project to an entity representing the match.

The actual type of the entity depends on the mapper used to create the query and on the indexes targeted by your query: the ORM mapper will return a managed entity loaded from the database, for example.

Returns:

A context allowing to define the projection more precisely.

field

default <T> FieldProjectionContext<T> field(String absoluteFieldPath,
                                            Class<T> type)

Project to the value of a field in the indexed document.

This method will apply projection converters on data fetched from the backend. See ProjectionConverter.ENABLED.

Type Parameters:

T - The resulting type of the projection.

Parameters:

absoluteFieldPath - The absolute path of the field.

type - The resulting type of the projection.

Returns:

A context allowing to define the projection more precisely.

field

<T> FieldProjectionContext<T> field(String absoluteFieldPath,
                                    Class<T> type,
                                    ProjectionConverter projectionConverter)

Project to the value of a field in the indexed document.

Type Parameters:

T - The resulting type of the projection.

Parameters:

absoluteFieldPath - The absolute path of the field.

type - The resulting type of the projection.

projectionConverter - Controls how the data fetched from the backend should be converted. See ProjectionConverter.

Returns:

A context allowing to define the projection more precisely.

field

default FieldProjectionContext<Object> field(String absoluteFieldPath)

Project to the value of a field in the indexed document, without specifying a type.

This method will apply projection converters on data fetched from the backend. See ProjectionConverter.ENABLED.

Parameters:

absoluteFieldPath - The absolute path of the field.

Returns:

A context allowing to define the projection more precisely.

field

FieldProjectionContext<Object> field(String absoluteFieldPath,
                                     ProjectionConverter projectionConverter)

Project to the value of a field in the indexed document, without specifying a type.

Parameters:

absoluteFieldPath - The absolute path of the field.

projectionConverter - Controls how the data fetched from the backend should be converted. See ProjectionConverter.

Returns:

A context allowing to define the projection more precisely.

score

ScoreProjectionContext score()

Project on the score of the hit.

Returns:

A context allowing to define the projection more precisely.

distance

DistanceToFieldProjectionContext distance(String absoluteFieldPath,
                                          GeoPoint center)

Project on the distance from the center to a GeoPoint field.

Parameters:

absoluteFieldPath - The absolute path of the field.

center - The center to compute the distance from.

Returns:

A context allowing to define the projection more precisely.

composite

default CompositeProjectionContext<List<?>> composite(SearchProjection<?>... projections)

Create a projection that will compose a List based on the given projections.

Parameters:

projections - The projections used to populate the list, in order.

Returns:

A context allowing to define the projection more precisely.

composite

default CompositeProjectionContext<List<?>> composite(SearchProjectionTerminalContext<?>... terminalContexts)

Create a projection that will compose a List based on the given almost-built projections.

Parameters:

terminalContexts - The terminal contexts allowing to retrieve SearchProjections.

Returns:

A context allowing to define the projection more precisely.

composite

<T> CompositeProjectionContext<T> composite(Function<List<?>,T> transformer,
                                            SearchProjection<?>... projections)

Create a projection that will compose a custom object based on the given projections.

Type Parameters:

T - The type of the custom object composing the projected elements.

Parameters:

transformer - The function that will transform the list of projected elements into a custom object.

projections - The projections used to populate the list, in order.

Returns:

A context allowing to define the projection more precisely.

composite

default <T> CompositeProjectionContext<T> composite(Function<List<?>,T> transformer,
                                                    SearchProjectionTerminalContext<?>... terminalContexts)

Create a projection that will compose a custom object based on the given almost-built projections.

Type Parameters:

T - The type of the custom object composing the projected elements.

Parameters:

transformer - The function that will transform the projected element into a custom object.

terminalContexts - The terminal contexts allowing to retrieve SearchProjections.

Returns:

A context allowing to define the projection more precisely.

composite

<P,T> CompositeProjectionContext<T> composite(Function<P,T> transformer,
                                              SearchProjection<P> projection)

Create a projection that will compose a custom object based on one given projection.

Type Parameters:

P - The type of the element passed to the transformer.

T - The type of the custom object composing the projected element.

Parameters:

transformer - The function that will transform the projected element into a custom object.

projection - The original projection used to produce the element passed to the transformer.

Returns:

A context allowing to define the projection more precisely.

composite

default <P,T> CompositeProjectionContext<T> composite(Function<P,T> transformer,
                                                      SearchProjectionTerminalContext<P> terminalContext)

Create a projection that will compose a custom object based on one almost-built projection.

Type Parameters:

P - The type of the element passed to the transformer.

T - The type of the custom object composing the projected element.

Parameters:

transformer - The function that will transform the projected element into a custom object.

terminalContext - The terminal context allowing to retrieve the SearchProjection that will be used to produce the element passed to the transformer.

Returns:

A context allowing to define the projection more precisely.

composite

<P1,P2,T> CompositeProjectionContext<T> composite(BiFunction<P1,P2,T> transformer,
                                                  SearchProjection<P1> projection1,
                                                  SearchProjection<P2> projection2)

Create a projection that will compose a custom object based on two given projections.

Type Parameters:

P1 - The type of the first element passed to the transformer.

P2 - The type of the second element passed to the transformer.

T - The type of the custom object composing the projected elements.

Parameters:

transformer - The function that will transform the projected elements into a custom object.

projection1 - The projection used to produce the first element passed to the transformer.

projection2 - The projection used to produce the second element passed to the transformer.

Returns:

A context allowing to define the projection more precisely.

composite

default <P1,P2,T> CompositeProjectionContext<T> composite(BiFunction<P1,P2,T> transformer,
                                                          SearchProjectionTerminalContext<P1> terminalContext1,
                                                          SearchProjectionTerminalContext<P2> terminalContext2)

Create a projection that will compose a custom object based on two almost-built projections.

Type Parameters:

P1 - The type of the first element passed to the transformer.

P2 - The type of the second element passed to the transformer.

T - The type of the custom object composing the projected elements.

Parameters:

transformer - The function that will transform the projected elements into a custom object.

terminalContext1 - The terminal context allowing to retrieve the SearchProjection that will be used to produce the first element passed to the transformer.

terminalContext2 - The terminal context allowing to retrieve the SearchProjection that will be used to produce the second element passed to the transformer.

Returns:

A context allowing to define the projection more precisely.

composite

<P1,P2,P3,T> CompositeProjectionContext<T> composite(TriFunction<P1,P2,P3,T> transformer,
                                                     SearchProjection<P1> projection1,
                                                     SearchProjection<P2> projection2,
                                                     SearchProjection<P3> projection3)

Create a projection that will compose a custom object based on three given projections.

Type Parameters:

P1 - The type of the first element passed to the transformer.

P2 - The type of the second element passed to the transformer.

P3 - The type of the third element passed to the transformer.

T - The type of the custom object composing the projected elements.

Parameters:

transformer - The function that will transform the projected elements into a custom object.

projection1 - The projection used to produce the first element passed to the transformer.

projection2 - The projection used to produce the second element passed to the transformer.

projection3 - The projection used to produce the third element passed to the transformer.

Returns:

A context allowing to define the projection more precisely.

composite

default <P1,P2,P3,T> CompositeProjectionContext<T> composite(TriFunction<P1,P2,P3,T> transformer,
                                                             SearchProjectionTerminalContext<P1> terminalContext1,
                                                             SearchProjectionTerminalContext<P2> terminalContext2,
                                                             SearchProjectionTerminalContext<P3> terminalContext3)

Create a projection that will compose a custom object based on three almost-built projections.

Type Parameters:

P1 - The type of the first element passed to the transformer.

P2 - The type of the second element passed to the transformer.

P3 - The type of the third element passed to the transformer.

T - The type of the custom object composing the projected elements.

Parameters:

transformer - The function that will transform the projected elements into a custom object.

terminalContext1 - The terminal context allowing to retrieve the SearchProjection that will be used to produce the first element passed to the transformer.

terminalContext2 - The terminal context allowing to retrieve the SearchProjection that will be used to produce the second element passed to the transformer.

terminalContext3 - The terminal context allowing to retrieve the SearchProjection that will be used to produce the third element passed to the transformer.

Returns:

A context allowing to define the projection more precisely.

extension

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

Extend the current context with the given extension, resulting in an extended context offering different types of projections.

Type Parameters:

T - The type of context provided by the extension.

Parameters:

extension - The extension to the projection DSL.

Returns:

The extended context.

Throws:

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

extension

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

Create a context allowing to try to apply multiple extensions one after the other, failing only if none of the extensions is supported.

If you only need to apply a single extension and fail if it is not supported, use the simpler extension(SearchProjectionFactoryContextExtension) method instead.

This method is generic, and you should set the generic type explicitly to the expected projected type, e.g. .<MyProjectedType>extension().

Type Parameters:

T - The expected projected type.

Returns:

A context allowing to define the extensions to attempt, and the corresponding projections.