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

Class HighlighterUnifiedOptionsStepImpl

java.lang.Object

org.hibernate.search.engine.search.highlighter.dsl.impl.HighlighterOptionsStepImpl<HighlighterUnifiedOptionsStep>

org.hibernate.search.engine.search.highlighter.dsl.impl.HighlighterUnifiedOptionsStepImpl

All Implemented Interfaces:

HighlighterFinalStep, HighlighterOptionsStep<HighlighterUnifiedOptionsStep>, HighlighterUnifiedOptionsStep

public class HighlighterUnifiedOptionsStepImpl
extends HighlighterOptionsStepImpl<HighlighterUnifiedOptionsStep>
implements HighlighterUnifiedOptionsStep

Field Summary

Fields inherited from class org.hibernate.search.engine.search.highlighter.dsl.impl.HighlighterOptionsStepImpl

highlighterBuilder

Constructor Summary

Constructors

Constructor	Description
HighlighterUnifiedOptionsStepImpl(SearchHighlighterBuilder highlightBuilder)

Method Summary

Modifier and Type	Method	Description
HighlighterBoundaryScannerTypeStep<?,? extends HighlighterUnifiedOptionsStep>	boundaryScanner()	Specify how the text should be broken up into highlighting snippets.
HighlighterUnifiedOptionsStep	boundaryScanner(Consumer<? super HighlighterBoundaryScannerTypeStep<?,?>> boundaryScannerContributor)	Specify how the text should be broken up into highlighting snippets.

Methods inherited from class org.hibernate.search.engine.search.highlighter.dsl.impl.HighlighterOptionsStepImpl

encoder, fragmentSize, noMatchSize, numberOfFragments, orderByScore, tag, toHighlighter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Details

HighlighterUnifiedOptionsStepImpl

public HighlighterUnifiedOptionsStepImpl(SearchHighlighterBuilder highlightBuilder)

Method Details

boundaryScanner

public HighlighterBoundaryScannerTypeStep<?,? extends HighlighterUnifiedOptionsStep> boundaryScanner()

Description copied from interface: HighlighterUnifiedOptionsStep

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

By default, a sentence boundary scanner is used.

Specified by:

boundaryScanner in interface HighlighterUnifiedOptionsStep

Returns:

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

boundaryScanner

public HighlighterUnifiedOptionsStep boundaryScanner(Consumer<? super HighlighterBoundaryScannerTypeStep<?,?>> boundaryScannerContributor)

Description copied from interface: HighlighterUnifiedOptionsStep

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

By default, a sentence boundary scanner is used.

Specified by:

boundaryScanner in interface HighlighterUnifiedOptionsStep

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.