Class FieldProjectionBinder
java.lang.Object
org.hibernate.search.mapper.pojo.search.definition.binding.builtin.FieldProjectionBinder
- All Implemented Interfaces:
ProjectionBinder
Binds a constructor parameter to a projection to the value of a field in the indexed document.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
bind
(ProjectionBindingContext context) Binds a constructor parameter to a projection.static FieldProjectionBinder
create()
Creates aFieldProjectionBinder
to be passed toMethodParameterMappingStep.projection(ProjectionBinder)
.static FieldProjectionBinder
Creates aFieldProjectionBinder
to be passed toMethodParameterMappingStep.projection(ProjectionBinder)
.valueConvert
(ValueConvert valueConvert)
-
Method Details
-
create
Creates aFieldProjectionBinder
to be passed toMethodParameterMappingStep.projection(ProjectionBinder)
.This method requires the projection constructor class to be compiled with the
-parameters
flag to infer the field path from the name of the constructor parameter being bound. If this compiler flag is not used, usecreate(String)
instead and pass the field path explicitly.- Returns:
- The binder.
-
create
Creates aFieldProjectionBinder
to be passed toMethodParameterMappingStep.projection(ProjectionBinder)
.- Parameters:
fieldPath
- The path to the index field whose value will be extracted. Whennull
, defaults to the name of the constructor parameter being bound, if it can be retrieved (requires the class to be compiled with the-parameters
flag; otherwise a nullfieldPath
will lead to a failure).- Returns:
- The binder.
-
valueConvert
- Parameters:
valueConvert
- Controls how the data fetched from the backend should be converted. SeeValueConvert
.- Returns:
this
, for method chaining.- See Also:
-
bind
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 interfaceProjectionBinder
- Parameters:
context
- A context object providing information about the constructor parameter being bound, and expecting a call to one of itsdefinition*(...)
methods.
-