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

Class DocumentReferenceProjectionBinder

java.lang.Object

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

All Implemented Interfaces:

ProjectionBinder

public final class DocumentReferenceProjectionBinder
extends Object
implements ProjectionBinder

Binds a constructor parameter to a projection to a DocumentReference representing the hit.

See Also:

• SearchProjectionFactory.documentReference()
• DocumentReferenceProjection

Method Summary

Modifier and Type	Method	Description
void	bind(ProjectionBindingContext context)	Binds a constructor parameter to a projection.
static DocumentReferenceProjectionBinder	create()	Creates a DocumentReferenceProjectionBinder 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 DocumentReferenceProjectionBinder create()

Creates a DocumentReferenceProjectionBinder 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.