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

Interface HighlighterFastVectorHighlighterOptionsStep

All Superinterfaces:

HighlighterFinalStep, HighlighterOptionsStep<HighlighterFastVectorHighlighterOptionsStep>

All Known Implementing Classes:

HighlighterFastVectorHighlighterOptionsStepImpl

public interface HighlighterFastVectorHighlighterOptionsStep
extends HighlighterOptionsStep<HighlighterFastVectorHighlighterOptionsStep>

The step in a fast vector 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
HighlighterBoundaryScannerTypeFastVectorHighlighterStep<? extends HighlighterFastVectorHighlighterOptionsStep>	boundaryScanner()	Specify how the text should be broken up into highlighting snippets.
HighlighterFastVectorHighlighterOptionsStep	boundaryScanner(Consumer<? super HighlighterBoundaryScannerTypeFastVectorHighlighterStep<?>> boundaryScannerContributor)	Specify how the text should be broken up into highlighting snippets.
HighlighterFastVectorHighlighterOptionsStep	phraseLimit(int limit)	Specify the maximum number of matching phrases in a document that are considered for highlighting.
HighlighterFastVectorHighlighterOptionsStep	tags(Collection<String> preTags, String postTag)	An alternative to tag definition.
HighlighterFastVectorHighlighterOptionsStep	tags(Collection<String> preTags, Collection<String> postTags)	An alternative to tag definition.
HighlighterFastVectorHighlighterOptionsStep	tagSchema(HighlighterTagSchema tagSchema)	Specify a set of predefined tags instead of manually supplying them.

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 Detail

phraseLimit

HighlighterFastVectorHighlighterOptionsStep phraseLimit(int limit)

Specify the maximum number of matching phrases in a document that are considered for highlighting.

Parameters:

limit - The maximum number of matching phrases.

Returns:

The next step in a highlighter definition.

tags

HighlighterFastVectorHighlighterOptionsStep tags(Collection<String> preTags,
                                                 String postTag)

An alternative to tag definition.

Any previous calls to HighlighterOptionsStep.tag(String, String)/tags(Collection, String)/tags(Collection, Collection)/tagSchema(HighlighterTagSchema) on this highlighter definition will be discarded and tags supplied here will be used.

Parameters:

preTags - The opening (pre) tags placed before the highlighted text.

postTag - The closing (post) tag placed after the highlighted text.

Returns:

The next step in a highlighter definition.

tags

HighlighterFastVectorHighlighterOptionsStep tags(Collection<String> preTags,
                                                 Collection<String> postTags)

An alternative to tag definition.

Any previous calls to HighlighterOptionsStep.tag(String, String)/tags(Collection, String)/tags(Collection, Collection)/tagSchema(HighlighterTagSchema) on this highlighter definition will be discarded and tags supplied here will be used.

Parameters:

preTags - The opening (pre) tags placed before the highlighted text.

postTags - The closing (post) tags placed after the highlighted text.

Returns:

The next step in a highlighter definition.

tagSchema

HighlighterFastVectorHighlighterOptionsStep tagSchema(HighlighterTagSchema tagSchema)

Specify a set of predefined tags instead of manually supplying them.

Any previous calls to HighlighterOptionsStep.tag(String, String)/tags(Collection, String)/tags(Collection, Collection) on this highlighter definition will be discarded and tags from the predefined schema will be used.

Parameters:

tagSchema - The tag schema to apply.

Returns:

The next step in a highlighter definition.

See Also:

HighlighterTagSchema

boundaryScanner

HighlighterBoundaryScannerTypeFastVectorHighlighterStep<? extends HighlighterFastVectorHighlighterOptionsStep> boundaryScanner()

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

By default, a character boundary scanner is used.

Returns:

The next step in a highlighter definition exposing boundary scanner specific options.

boundaryScanner

HighlighterFastVectorHighlighterOptionsStep boundaryScanner(Consumer<? super HighlighterBoundaryScannerTypeFastVectorHighlighterStep<?>> boundaryScannerContributor)

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

By default, a character boundary scanner is used.

Parameters:

boundaryScannerContributor - A consumer that will configure a boundary scanner for this highlighter. Should generally be a lambda expression.

Returns:

The next step in a highlighter definition.