Package org.hibernate.search.engine.search.highlighter.dsl

Interface HighlighterPlainOptionsStep

All Superinterfaces:

HighlighterFinalStep, HighlighterOptionsStep<HighlighterPlainOptionsStep>

public interface HighlighterPlainOptionsStep
extends HighlighterOptionsStep<HighlighterPlainOptionsStep>

The step in a plain highlighter definition where options can be set. Refer to your particular backend documentation for more detailed information on the exposed settings.

Method Summary

Modifier and Type	Method	Description
HighlighterPlainOptionsStep	fragmenter(HighlighterFragmenter type)	Specify how the text should be broken up into highlighting snippets.

Methods inherited from interface org.hibernate.search.engine.search.highlighter.dsl.HighlighterFinalStep

toHighlighter

Methods inherited from interface org.hibernate.search.engine.search.highlighter.dsl.HighlighterOptionsStep

encoder, fragmentSize, noMatchSize, numberOfFragments, orderByScore, tag

Method Details

fragmenter

HighlighterPlainOptionsStep fragmenter(HighlighterFragmenter type)

Specify how the text should be broken up into highlighting snippets.

Parameters:

type - The type of fragmeter to be applied.

Returns:

The next step in a highlighter definition.

See Also:

• HighlighterFragmenter