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

Interface CompositeProjectionInnerStep

All Known Implementing Classes:

CompositeProjectionInnerStepImpl

public interface CompositeProjectionInnerStep

A step in a "multi-step" composite projection definition where one can define inner projections to get values from.

Method Summary

Modifier and Type	Method	Description
<V> CompositeProjectionValueStep<?,V>	as(Class<V> objectClass)	Defines the result of the composite projection as the result of applying the given function to the single inner projection defined so far.
CompositeProjectionFromAsStep	from(ProjectionFinalStep<?>... dslFinalSteps)	Defines multiple inner projections to get values from, based on almost-built SearchProjections.
default <V1> CompositeProjectionFrom1AsStep<V1>	from(ProjectionFinalStep<V1> dslFinalStep)	Defines one inner projection to get values from, based on an almost-built SearchProjection.
default <V1,V2> CompositeProjectionFrom2AsStep<V1,V2>	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>	from(ProjectionFinalStep<V1> dslFinalStep1, ProjectionFinalStep<V2> dslFinalStep2, ProjectionFinalStep<V3> dslFinalStep3)	Defines three inner projections to get values from, based on almost-built SearchProjections.
CompositeProjectionFromAsStep	from(SearchProjection<?>... projections)	Defines multiple inner projections to get values from, based on previously-built SearchProjections.
<V1> CompositeProjectionFrom1AsStep<V1>	from(SearchProjection<V1> projection)	Defines one inner projection to get values from, based on a previously-built SearchProjection.
<V1,V2> CompositeProjectionFrom2AsStep<V1,V2>	from(SearchProjection<V1> projection1, SearchProjection<V2> projection2)	Defines two inner projections to get values from, based on previously-built SearchProjections.
<V1,V2,V3> CompositeProjectionFrom3AsStep<V1,V2,V3>	from(SearchProjection<V1> projection1, SearchProjection<V2> projection2, SearchProjection<V3> projection3)	Defines three inner projections to get values from, based on previously-built SearchProjections.

Method Detail

as

<V> CompositeProjectionValueStep<?,V> as(Class<V> objectClass)

Defines the result of the composite projection as the result of applying the given function to the single inner projection defined so far.

Type Parameters:

V - The type of objects returned by the projection.

Parameters:

objectClass - The type of objects returned by the projection. The class is expected to be mapped (generally through annotations) in such a way that it defines the inner projections.

Returns:

The next DSL step.

from

<V1> CompositeProjectionFrom1AsStep<V1> from(SearchProjection<V1> projection)

Defines one inner projection to get values from, based on a previously-built SearchProjection.

Type Parameters:

V1 - The type of values returned by the inner projection.

Parameters:

projection - The inner projection.

Returns:

The next DSL step.

from

default <V1> CompositeProjectionFrom1AsStep<V1> from(ProjectionFinalStep<V1> dslFinalStep)

Defines one inner projection to get values from, based on an almost-built SearchProjection.

Type Parameters:

V1 - The type of values returned by the inner projection.

Parameters:

dslFinalStep - A final step in the projection DSL allowing the retrieval of the inner projection.

Returns:

The next DSL step.

from

<V1,V2> CompositeProjectionFrom2AsStep<V1,V2> from(SearchProjection<V1> projection1,
                                                               SearchProjection<V2> projection2)

Defines two inner projections to get values from, based on previously-built SearchProjections.

Type Parameters:

V1 - The type of values returned by the first inner projection.

V2 - The type of values returned by the second inner projection.

Parameters:

projection1 - The first inner projection.

projection2 - The second inner projection.

Returns:

The next DSL step.

from

default <V1,V2> CompositeProjectionFrom2AsStep<V1,V2> from(ProjectionFinalStep<V1> dslFinalStep1,
                                                                       ProjectionFinalStep<V2> dslFinalStep2)

Defines two inner projections to get values from, based on almost-built SearchProjections.

Type Parameters:

V1 - The type of values returned by the first inner projection.

V2 - The type of values returned by the second inner projection.

Parameters:

dslFinalStep1 - A final step in the projection DSL allowing the retrieval of the first inner projection.

dslFinalStep2 - A final step in the projection DSL allowing the retrieval of the second inner projection.

Returns:

The next DSL step.

from

<V1,V2,V3> CompositeProjectionFrom3AsStep<V1,V2,V3> from(SearchProjection<V1> projection1,
                                                                                 SearchProjection<V2> projection2,
                                                                                 SearchProjection<V3> projection3)

Defines three inner projections to get values from, based on previously-built SearchProjections.

Type Parameters:

V1 - The type of values returned by the first inner projection.

V2 - The type of values returned by the second inner projection.

V3 - The type of values returned by the third inner projection.

Parameters:

projection1 - The first inner projection.

projection2 - The second inner projection.

projection3 - The third inner projection.

Returns:

The next DSL step.

from

default <V1,V2,V3> CompositeProjectionFrom3AsStep<V1,V2,V3> from(ProjectionFinalStep<V1> dslFinalStep1,
                                                                                         ProjectionFinalStep<V2> dslFinalStep2,
                                                                                         ProjectionFinalStep<V3> dslFinalStep3)

Defines three inner projections to get values from, based on almost-built SearchProjections.

Type Parameters:

V1 - The type of values returned by the first inner projection.

V2 - The type of values returned by the second inner projection.

V3 - The type of values returned by the third inner projection.

Parameters:

dslFinalStep1 - A final step in the projection DSL allowing the retrieval of the first inner projection.

dslFinalStep2 - A final step in the projection DSL allowing the retrieval of the second inner projection.

dslFinalStep3 - A final step in the projection DSL allowing the retrieval of the third inner projection.

Returns:

The next DSL step.

from

CompositeProjectionFromAsStep from(SearchProjection<?>... projections)

Defines multiple inner projections to get values from, based on previously-built SearchProjections.

Parameters:

projections - The inner projections, in order.

Returns:

The next DSL step.

from

CompositeProjectionFromAsStep from(ProjectionFinalStep<?>... dslFinalSteps)

Defines multiple inner projections to get values from, based on almost-built SearchProjections.

Parameters:

dslFinalSteps - The final steps in the projection DSL allowing the retrieval of inner projections, in order.

Returns:

The next DSL step.