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

Class FieldProjectionValueStepImpl<T>

java.lang.Object

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

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

All Implemented Interfaces:

FieldProjectionOptionsStep<FieldProjectionOptionsStepImpl<T,T>,T>, FieldProjectionValueStep<FieldProjectionOptionsStepImpl<T,T>,T>, ProjectionFinalStep<T>

public final class FieldProjectionValueStepImpl<T>
extends FieldProjectionOptionsStepImpl<T,T>
implements FieldProjectionValueStep<FieldProjectionOptionsStepImpl<T,T>,T>

Field Summary

Fields inherited from class org.hibernate.search.engine.search.projection.dsl.impl.FieldProjectionOptionsStepImpl

fieldProjectionBuilder

Constructor Summary

Constructors

Constructor	Description
FieldProjectionValueStepImpl(SearchProjectionDslContext<?> dslContext, String fieldPath, Class<T> clazz, ValueConvert convert)

Method Summary

Modifier and Type	Method	Description
FieldProjectionOptionsStep<?,List<T>>	multi()	Defines the projection as multi-valued, i.e.
SearchProjection<T>	toProjection()	Create a SearchProjection instance matching the definition given in the previous DSL steps.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldProjectionValueStepImpl

public FieldProjectionValueStepImpl(SearchProjectionDslContext<?> dslContext,
                                    String fieldPath,
                                    Class<T> clazz,
                                    ValueConvert convert)

Method Detail

multi

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

Description copied from interface: FieldProjectionValueStep

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

Calling FieldProjectionValueStep.multi() is mandatory for multi-valued fields, otherwise the projection will throw an exception upon creating the query.

Specified by:

multi in interface FieldProjectionValueStep<FieldProjectionOptionsStepImpl<T,T>,T>

Returns:

A new step to define optional parameters for the multi-valued projections.

toProjection

public SearchProjection<T> toProjection()

Description copied from interface: ProjectionFinalStep

Create a SearchProjection instance matching the definition given in the previous DSL steps.

Specified by:

toProjection in interface ProjectionFinalStep<T>

Overrides:

toProjection in class FieldProjectionOptionsStepImpl<T,T>

Returns:

The SearchProjection instance.