Uses of Interface
org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep

Packages that use ProjectionFinalStep

Package	Description
org.hibernate.search.backend.elasticsearch.search.projection.dsl
org.hibernate.search.backend.elasticsearch.search.query.dsl
org.hibernate.search.backend.lucene.search.projection.dsl
org.hibernate.search.backend.lucene.search.query.dsl
org.hibernate.search.engine.search.projection.dsl
org.hibernate.search.engine.search.projection.dsl.spi
org.hibernate.search.engine.search.projection.spi
org.hibernate.search.engine.search.query.dsl
org.hibernate.search.engine.search.query.dsl.spi

Uses of ProjectionFinalStep in org.hibernate.search.backend.elasticsearch.search.projection.dsl

Methods in org.hibernate.search.backend.elasticsearch.search.projection.dsl that return ProjectionFinalStep

Modifier and Type	Method	Description
ProjectionFinalStep<com.google.gson.JsonObject>	ElasticsearchSearchProjectionFactory.explanation()	Project to a JsonObject describing the score computation for the hit.
ProjectionFinalStep<com.google.gson.JsonObject>	ElasticsearchSearchProjectionFactory.jsonHit()	Project to a JsonObject representing the hit as returned by Elasticsearch.
ProjectionFinalStep<com.google.gson.JsonObject>	ElasticsearchSearchProjectionFactory.source()	Project to a JsonObject representing the document as stored in Elasticsearch.

Uses of ProjectionFinalStep in org.hibernate.search.backend.elasticsearch.search.query.dsl

Method parameters in org.hibernate.search.backend.elasticsearch.search.query.dsl with type arguments of type ProjectionFinalStep

Modifier and Type	Method	Description
<P> ElasticsearchSearchQueryWhereStep<SR,P,LOS>	ElasticsearchSearchQuerySelectStep.select(Function<? super ElasticsearchSearchProjectionFactory<SR,R,E>,? extends ProjectionFinalStep<P>> projectionContributor)

Uses of ProjectionFinalStep in org.hibernate.search.backend.lucene.search.projection.dsl

Methods in org.hibernate.search.backend.lucene.search.projection.dsl that return ProjectionFinalStep

Modifier and Type	Method	Description
ProjectionFinalStep<Document>	LuceneSearchProjectionFactory.document()	Project to a Lucene Document containing all the stored fields.
ProjectionFinalStep<DocumentTree>	LuceneSearchProjectionFactory.documentTree()	Project to a DocumentTree containing all the stored fields and nested documents.
ProjectionFinalStep<Explanation>	LuceneSearchProjectionFactory.explanation()	Project to a Lucene Explanation describing the score computation for the hit.

Uses of ProjectionFinalStep in org.hibernate.search.backend.lucene.search.query.dsl

Method parameters in org.hibernate.search.backend.lucene.search.query.dsl with type arguments of type ProjectionFinalStep

Modifier and Type	Method	Description
<P> LuceneSearchQueryWhereStep<SR,P,LOS>	LuceneSearchQuerySelectStep.select(Function<? super LuceneSearchProjectionFactory<SR,R,E>,? extends ProjectionFinalStep<P>> projectionContributor)

Uses of ProjectionFinalStep in org.hibernate.search.engine.search.projection.dsl

Subinterfaces of ProjectionFinalStep in org.hibernate.search.engine.search.projection.dsl

Modifier and Type	Interface	Description
interface	CompositeProjectionOptionsStep<S extends CompositeProjectionOptionsStep<?,T>,T>	The final step in a composite projection definition where optional parameters can be set.
interface	CompositeProjectionValueStep<N extends CompositeProjectionOptionsStep<?,T>,T>	The step in a composite projection definition where (optionally) the projection collector can be provided, e.g. to mark a projection as multi-valued (returning List/Set etc.)
interface	DistanceToFieldProjectionOptionsStep<S extends DistanceToFieldProjectionOptionsStep<?,T>,T>	The initial and final step in a "distance to field" projection definition, where optional parameters can be set.
interface	DistanceToFieldProjectionValueStep<N extends DistanceToFieldProjectionOptionsStep<?,T>,T>	The initial step in a "distance to field" projection definition, where (optionally) the projection collector can be provided, e.g. to mark a projection as multi-valued (returning List/Set etc.)
interface	DocumentReferenceProjectionOptionsStep<S extends DocumentReferenceProjectionOptionsStep<?>>	The initial and final step in a "document reference" projection definition, where optional parameters can be set.
interface	EntityProjectionOptionsStep<S extends EntityProjectionOptionsStep<?,E>,E>	The initial and final step in an "entity" projection definition, where optional parameters can be set.
interface	EntityReferenceProjectionOptionsStep<S extends EntityReferenceProjectionOptionsStep<?,R>,R>	The initial and final step in an "entity reference" projection definition, where optional parameters can be set.
interface	FieldProjectionOptionsStep<S extends FieldProjectionOptionsStep<?,T>,T>	The initial and final step in a "field" projection definition, where optional parameters can be set.
interface	FieldProjectionValueStep<N extends FieldProjectionOptionsStep<?,T>,T>	The initial step in a "field" projection definition, where (optionally) the projection collector can be provided, e.g. to mark a projection as multi-valued (returning List/Set etc.)
interface	HighlightProjectionFinalStep	The final step in a highlight definition.
interface	HighlightProjectionOptionsStep	The initial and final step in a highlight definition, where optional parameters can be set.
interface	IdProjectionOptionsStep<S extends IdProjectionOptionsStep<?,I>,I>	The initial and final step in an "id" projection definition, where optional parameters can be set.
interface	ScoreProjectionOptionsStep<S extends ScoreProjectionOptionsStep<?>>	The initial and final step in a "score" projection definition, where optional parameters can be set.
interface	SingleHighlightProjectionFinalStep	The final step in a single-valued highlight definition.

Methods in org.hibernate.search.engine.search.projection.dsl that return ProjectionFinalStep

Modifier and Type	Method	Description
default ProjectionFinalStep<String[]>	HighlightProjectionOptionsStep.array()	Changes the collection accumulating the values to String[] instead of List.
<R> ProjectionFinalStep<R>	HighlightProjectionOptionsStep.collector(ProjectionCollector.Provider<String,R> collector)	Defines the collector to apply to the highlighted strings.
<T> ProjectionFinalStep<T>	SearchProjectionFactory.constant(T value)	Project to a given constant.
default ProjectionFinalStep<String>	HighlightProjectionOptionsStep.nullable()	Defines the projection as single-valued, i.e. returning String instead of List<String>.
default ProjectionFinalStep<Optional<String>>	HighlightProjectionOptionsStep.optional()	Defines the projection as single-valued wrapped in an Optional, i.e. returning Optional<String> instead of List<String>.
ProjectionFinalStep<P>	SearchProjectionFactoryExtensionIfSupportedMoreStep.orElse(Function<SearchProjectionFactory<SR,R,E>,? extends ProjectionFinalStep<P>> projectionContributor)	If no extension passed to SearchProjectionFactoryExtensionIfSupportedStep.ifSupported(SearchProjectionFactoryExtension, Function) was supported so far, apply the given function to the current (non-extended) SearchProjectionFactory; otherwise return the projection created in the first succeeding ifSupported call.
ProjectionFinalStep<P>	SearchProjectionFactoryExtensionIfSupportedMoreStep.orElseFail()	If no extension passed to SearchProjectionFactoryExtensionIfSupportedStep.ifSupported(SearchProjectionFactoryExtension, Function) was supported so far, throw an exception; otherwise return the projection created in the first succeeding ifSupported call.
default ProjectionFinalStep<Set<String>>	HighlightProjectionOptionsStep.set()	Changes the collection accumulating the values to Set instead of List.
default ProjectionFinalStep<SortedSet<String>>	HighlightProjectionOptionsStep.sortedSet()	Changes the collection accumulating the values to SortedSet instead of List.
default ProjectionFinalStep<SortedSet<String>>	HighlightProjectionOptionsStep.sortedSet(Comparator<String> comparator)	Changes the collection accumulating the values to SortedSet instead of List.
<T> ProjectionFinalStep<T>	SearchProjectionFactory.withParameters(Function<? super NamedValues,? extends ProjectionFinalStep<T>> projectionCreator)	Delegating projection that creates the actual projection at query create time and provides access to query parameters.

Methods in org.hibernate.search.engine.search.projection.dsl with parameters of type ProjectionFinalStep

Modifier and Type	Method	Description
default <P1, P2, T> CompositeProjectionOptionsStep<?,T>	SearchProjectionFactory.composite(BiFunction<P1,P2,T> transformer, ProjectionFinalStep<P1> dslFinalStep1, ProjectionFinalStep<P2> dslFinalStep2)	Deprecated. Use .composite().from( dslFinalStep1, dslFinalStep2 ).as( transformer ) instead.
default <T> CompositeProjectionOptionsStep<?,T>	SearchProjectionFactory.composite(Function<List<?>,T> transformer, ProjectionFinalStep<?>... dslFinalSteps)	Deprecated. Use .composite().from( dslFinalSteps ).asList( transformer ) instead.
default <P, T> CompositeProjectionOptionsStep<?,T>	SearchProjectionFactory.composite(Function<P,T> transformer, ProjectionFinalStep<P> dslFinalStep)	Deprecated. Use .composite().from( dslFinalStep ).as( transformer ) instead.
default CompositeProjectionValueStep<?,List<?>>	SearchProjectionFactory.composite(ProjectionFinalStep<?>... dslFinalSteps)	Create a projection that will compose a List based on the given almost-built projections.
default <P1, P2, P3, T> CompositeProjectionOptionsStep<?,T>	SearchProjectionFactory.composite(TriFunction<P1,P2,P3,T> transformer, ProjectionFinalStep<P1> dslFinalStep1, ProjectionFinalStep<P2> dslFinalStep2, ProjectionFinalStep<P3> dslFinalStep3)	Deprecated. Use .composite().from( dslFinalStep1, dslFinalStep2, dslFinalStep3 ).as( transformer ) instead.
CompositeProjectionFromAsStep	CompositeProjectionInnerStep.from(ProjectionFinalStep<?>... dslFinalSteps)	Defines multiple inner projections to get values from, based on almost-built SearchProjections.
default <V1> CompositeProjectionFrom1AsStep<V1>	CompositeProjectionInnerStep.from(ProjectionFinalStep<V1> dslFinalStep)	Defines one inner projection to get values from, based on an almost-built SearchProjection.
default <V1, V2> CompositeProjectionFrom2AsStep<V1,V2>	CompositeProjectionInnerStep.from(ProjectionFinalStep<V1> dslFinalStep1, ProjectionFinalStep<V2> dslFinalStep2)	Defines two inner projections to get values from, based on almost-built SearchProjections.
default <V1, V2, V3> CompositeProjectionFrom3AsStep<V1,V2,V3>	CompositeProjectionInnerStep.from(ProjectionFinalStep<V1> dslFinalStep1, ProjectionFinalStep<V2> dslFinalStep2, ProjectionFinalStep<V3> dslFinalStep3)	Defines three inner projections to get values from, based on almost-built SearchProjections.

Method parameters in org.hibernate.search.engine.search.projection.dsl with type arguments of type ProjectionFinalStep

Modifier and Type	Method	Description
<T> SearchProjectionFactoryExtensionIfSupportedMoreStep<SR,P,R,E>	SearchProjectionFactoryExtensionIfSupportedStep.ifSupported(SearchProjectionFactoryExtension<SR,T,R,E> extension, Function<T,? extends ProjectionFinalStep<P>> projectionContributor)	If the given extension is supported, and none of the previous extensions passed to SearchProjectionFactoryExtensionIfSupportedStep.ifSupported(SearchProjectionFactoryExtension, Function) was supported, extend the current factory with this extension, apply the given function to the extended factory, and store the resulting projection for later retrieval.
ProjectionFinalStep<P>	SearchProjectionFactoryExtensionIfSupportedMoreStep.orElse(Function<SearchProjectionFactory<SR,R,E>,? extends ProjectionFinalStep<P>> projectionContributor)	If no extension passed to SearchProjectionFactoryExtensionIfSupportedStep.ifSupported(SearchProjectionFactoryExtension, Function) was supported so far, apply the given function to the current (non-extended) SearchProjectionFactory; otherwise return the projection created in the first succeeding ifSupported call.
<T> ProjectionFinalStep<T>	SearchProjectionFactory.withParameters(Function<? super NamedValues,? extends ProjectionFinalStep<T>> projectionCreator)	Delegating projection that creates the actual projection at query create time and provides access to query parameters.

Uses of ProjectionFinalStep in org.hibernate.search.engine.search.projection.dsl.spi

Classes in org.hibernate.search.engine.search.projection.dsl.spi that implement ProjectionFinalStep

Modifier and Type	Class	Description
final class	StaticProjectionFinalStep<T>

Methods in org.hibernate.search.engine.search.projection.dsl.spi that return ProjectionFinalStep

Modifier and Type	Method	Description
<T> ProjectionFinalStep<T>	AbstractSearchProjectionFactory.constant(T value)
<T> ProjectionFinalStep<T>	AbstractSearchProjectionFactory.withParameters(Function<? super NamedValues,? extends ProjectionFinalStep<T>> projectionCreator)

Method parameters in org.hibernate.search.engine.search.projection.dsl.spi with type arguments of type ProjectionFinalStep

Modifier and Type	Method	Description
<T> ProjectionFinalStep<T>	AbstractSearchProjectionFactory.withParameters(Function<? super NamedValues,? extends ProjectionFinalStep<T>> projectionCreator)

Uses of ProjectionFinalStep in org.hibernate.search.engine.search.projection.spi

Method parameters in org.hibernate.search.engine.search.projection.spi with type arguments of type ProjectionFinalStep

Modifier and Type	Method	Description
<T> SearchProjection<T>	SearchProjectionBuilderFactory.withParameters(Function<? super NamedValues,? extends ProjectionFinalStep<T>> projectionCreator)

Uses of ProjectionFinalStep in org.hibernate.search.engine.search.query.dsl

Method parameters in org.hibernate.search.engine.search.query.dsl with type arguments of type ProjectionFinalStep

Modifier and Type	Method	Description
<P> SearchQueryWhereStep<SR,?,P,LOS,?>	SearchQuerySelectStep.select(Function<? super PJF,? extends ProjectionFinalStep<P>> projectionContributor)	Select a given projection as a representation of the search hit for each matching document.

Uses of ProjectionFinalStep in org.hibernate.search.engine.search.query.dsl.spi

Method parameters in org.hibernate.search.engine.search.query.dsl.spi with type arguments of type ProjectionFinalStep

Modifier and Type	Method	Description
<P> SearchQueryWhereStep<SR,?,P,LOS,?>	AbstractDelegatingSearchQuerySelectStep.select(Function<? super SearchProjectionFactory<SR,R,E>,? extends ProjectionFinalStep<P>> projectionContributor)