Package org.hibernate.search.mapper.pojo.mapping.definition.annotation

Annotation Interface HighlightProjection

@Documented
@Target(PARAMETER)
@Retention(RUNTIME)
@MethodParameterMapping(processor=@MethodParameterMappingAnnotationProcessorRef(type=HighlightProjectionProcessor.class,retrieval=CONSTRUCTOR))
public @interface HighlightProjection

Maps a constructor parameter to a projection to highlights, i.e. sequences of text that matched the query, extracted from the given field's value.

See Also:

• SearchProjectionFactory.highlight(String)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	highlighter
String	path

Element Details

path

String path

Returns:

The path to the index field whose value will be extracted. Defaults to the name of the annotated constructor parameter, if it can be retrieved (requires the class to be compiled with the -parameters flag; otherwise an empty path will lead to a failure).

See Also:

• SearchProjectionFactory.highlight(String)

Default:

""

highlighter

String highlighter

Returns:

The name of a highlighter defined on the query. Defaults to the default (unnamed) highlighter.

See Also:

• HighlightProjectionOptionsStep.highlighter(String)

Default:

""