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

Class CompositeProjectionValueStepImpl<T>

java.lang.Object

org.hibernate.search.engine.search.projection.dsl.impl.CompositeProjectionOptionsStepImpl<T,T>

org.hibernate.search.engine.search.projection.dsl.impl.CompositeProjectionValueStepImpl<T>

All Implemented Interfaces:

CompositeProjectionOptionsStep<CompositeProjectionOptionsStepImpl<T,T>,T>, CompositeProjectionValueStep<CompositeProjectionOptionsStepImpl<T,T>,T>, ProjectionFinalStep<T>

public class CompositeProjectionValueStepImpl<T>
extends CompositeProjectionOptionsStepImpl<T,T>
implements CompositeProjectionValueStep<CompositeProjectionOptionsStepImpl<T,T>,T>

Constructor Summary

Constructors

Constructor	Description
CompositeProjectionValueStepImpl(CompositeProjectionBuilder builder, SearchProjection<?>[] inners, ProjectionCompositor<?,T> compositor)

Method Summary

Modifier and Type	Method	Description
CompositeProjectionOptionsStep<?,List<T>>	multi()	Defines the projection as multi-valued, i.e. returning List<T> instead of T.

Methods inherited from class org.hibernate.search.engine.search.projection.dsl.impl.CompositeProjectionOptionsStepImpl

toProjection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep

toProjection

Constructor Details

CompositeProjectionValueStepImpl

public CompositeProjectionValueStepImpl(CompositeProjectionBuilder builder,
 SearchProjection<?>[] inners,
 ProjectionCompositor<?,T> compositor)

Method Details

multi

public CompositeProjectionOptionsStep<?,List<T>> multi()

Description copied from interface: CompositeProjectionValueStep

Defines the projection as multi-valued, i.e. returning List<T> instead of T.

Calling CompositeProjectionValueStep.multi() is mandatory for object projections on multi-valued object fields, otherwise the projection will throw an exception upon creating the search query.

Calling CompositeProjectionValueStep.multi() on basic composite projections is generally not useful: the only effect is that projected values will be wrapped in a one-element List.

Specified by:

multi in interface CompositeProjectionValueStep<CompositeProjectionOptionsStepImpl<T,T>,T>

Returns:

A new step to define optional parameters for the projection.