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

Interface HighlightProjectionOptionsStep

All Superinterfaces:

HighlightProjectionFinalStep, ProjectionFinalStep<List<String>>

All Known Implementing Classes:

HighlightProjectionOptionsStepImpl

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
HighlightProjectionOptionsStep	highlighter(String highlighterName)	Defines a name of a named highlighter to be used by this field projection.
SingleHighlightProjectionFinalStep	single()	Defines the projection as single-valued, i.e. returning String instead of List<String>.

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

toProjection

Method Details

highlighter

HighlightProjectionOptionsStep 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)

single

SingleHighlightProjectionFinalStep single()

Defines the projection as single-valued, i.e. returning String instead of List<String>.

Can only be used when the highlighter that creates highlighted fragments for this projection is configured to return a single fragment at most, i.e. when .numberOfFragments(1) is applied to the highlighter. Otherwise, it will lead to an exception being thrown when the query is created.

Returns:

A final step in the highlight projection definition.

See Also:

• HighlighterOptionsStep.numberOfFragments(int)