Package org.hibernate.search.mapper.pojo.search.definition.binding.builtin

Class CompositeProjectionBinder

java.lang.Object

org.hibernate.search.mapper.pojo.search.definition.binding.builtin.CompositeProjectionBinder

All Implemented Interfaces:

ProjectionBinder

public final class CompositeProjectionBinder
extends Object
implements ProjectionBinder

Binds a constructor parameter to a composite projection, which will combine multiple inner projections.

The content of the composite projection is defined in the constructor parameter type by another ProjectionConstructor.

On contrary to the object projection, a composite projection is not bound to a specific object field, and thus it will always yield one and only one value.

See Also:

• SearchProjectionFactory.composite()
• CompositeProjectionInnerStep.as(Class)
• CompositeProjection

Method Summary

Modifier and Type	Method	Description
void	bind(ProjectionBindingContext context)	Binds a constructor parameter to a projection.
static CompositeProjectionBinder	create()	Creates an CompositeProjectionBinder to be passed to MethodParameterMappingStep.projection(ProjectionBinder).

Methods inherited from class java.lang.Object

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

Method Details

create

public static CompositeProjectionBinder create()

Creates an CompositeProjectionBinder to be passed to MethodParameterMappingStep.projection(ProjectionBinder).

Returns:

The binder.

bind

public void bind(ProjectionBindingContext context)

Description copied from interface: ProjectionBinder

Binds a constructor parameter to a projection.

The context passed in parameter provides various information about the constructor parameter being bound. Implementations are expected to take advantage of that information and to call one of the definition*(...) methods on the context to set the projection.

Specified by:

bind in interface ProjectionBinder

Parameters:

context - A context object providing information about the constructor parameter being bound, and expecting a call to one of its definition*(...) methods.