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

Interface ProjectionBinder

All Known Implementing Classes:

CompositeProjectionBinder, DocumentReferenceProjectionBinder, EntityProjectionBinder, EntityReferenceProjectionBinder, FieldProjectionBinder, HighlightProjectionBinder, IdProjectionBinder, ObjectProjectionBinder, ProjectionBinderRef.UndefinedImplementationType, ScoreProjectionBinder

@Incubating
public interface ProjectionBinder

A component able to define a projection using the Hibernate Search Projection DSL.

This definition takes advantage of provided metadata to pick, configure and create a SearchProjection.

Used in particular for projections defined using mapper features, e.g. Java annotations (see IdProjection, FieldProjection).

See Also:

SearchProjection, ProjectionDefinition

Method Summary

Modifier and Type	Method	Description
void	bind(ProjectionBindingContext context)	Binds a constructor parameter to a projection.

Method Detail

bind

void bind(ProjectionBindingContext context)

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.

Parameters:

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