Package org.hibernate.search.engine.search.projection.dsl

Interface HighlightProjectionOptionsStep

All Superinterfaces:

HighlightProjectionFinalStep, ProjectionFinalStep<List<String>>

public interface HighlightProjectionOptionsStep
extends HighlightProjectionFinalStep

The initial and final step in a highlight definition, where optional parameters can be set.

Method Summary

Modifier and Type	Method	Description
HighlightProjectionFinalStep	highlighter(String highlighterName)	Defines a name of a named highlighter to be used by this field projection.

Methods inherited from interface org.hibernate.search.engine.search.projection.dsl.ProjectionFinalStep

toProjection

Method Details

highlighter

HighlightProjectionFinalStep highlighter(String highlighterName)

Defines a name of a named highlighter to be used by this field projection.

Parameters:

highlighterName - The name of a highlighter defined on the query.

Returns:

A final step to finish the definition of a highlight projection.

See Also:

• SearchQueryOptionsStep.highlighter(String, Function)