Class HighlightProjectionBinder
- java.lang.Object
-
- org.hibernate.search.mapper.pojo.search.definition.binding.builtin.HighlightProjectionBinder
-
- All Implemented Interfaces:
ProjectionBinder
public final class HighlightProjectionBinder extends Object implements ProjectionBinder
Binds a constructor parameter to a projection to highlights, i.e. sequences of text that matched the query, extracted from the given field's value.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbind(ProjectionBindingContext context)Binds a constructor parameter to a projection.static HighlightProjectionBindercreate()Creates aHighlightProjectionBinderto be passed toMethodParameterMappingStep.projection(ProjectionBinder).static HighlightProjectionBindercreate(String fieldPath)Creates aFieldProjectionBinderto be passed toMethodParameterMappingStep.projection(ProjectionBinder).HighlightProjectionBinderhighlighter(String highlighterName)
-
-
-
Method Detail
-
create
public static HighlightProjectionBinder create()
Creates aHighlightProjectionBinderto be passed toMethodParameterMappingStep.projection(ProjectionBinder).This method requires the projection constructor class to be compiled with the
-parametersflag 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
public static HighlightProjectionBinder create(String fieldPath)
Creates aFieldProjectionBinderto be passed toMethodParameterMappingStep.projection(ProjectionBinder).- Parameters:
fieldPath- The path to the index field whose highlights 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-parametersflag; otherwise a nullfieldPathwill lead to a failure).- Returns:
- The binder.
-
highlighter
public HighlightProjectionBinder highlighter(String highlighterName)
- Parameters:
highlighterName- The name of a highlighterdefined on the query, ornullto use the default highlighter.- Returns:
this, for method chaining.- See Also:
HighlightProjectionOptionsStep.highlighter(String)
-
bind
public void bind(ProjectionBindingContext context)
Description copied from interface:ProjectionBinderBinds 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:
bindin interfaceProjectionBinder- Parameters:
context- A context object providing information about the constructor parameter being bound, and expecting a call to one of itsdefinition*(...)methods.
-
-