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

Interface HighlighterBoundaryScannerFastVectorHighlighterOptionsStep<T extends HighlighterOptionsStep<?>>

All Superinterfaces:

HighlighterBoundaryScannerFinalStep<T>, HighlighterBoundaryScannerOptionsStep<HighlighterBoundaryScannerFastVectorHighlighterOptionsStep<T>,T>

public interface HighlighterBoundaryScannerFastVectorHighlighterOptionsStep<T extends HighlighterOptionsStep<?>>
extends HighlighterBoundaryScannerOptionsStep<HighlighterBoundaryScannerFastVectorHighlighterOptionsStep<T>,T>

The step in a highlighter definition where boundary scanner 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
HighlighterBoundaryScannerFastVectorHighlighterOptionsStep<T>	boundaryChars(Character[] boundaryChars)	Specify a set of characters to look for when scanning for boundaries when a characters boundary scanner is used.
HighlighterBoundaryScannerFastVectorHighlighterOptionsStep<T>	boundaryChars(String boundaryChars)	Specify a set of characters to look for when scanning for boundaries when a characters boundary scanner is used.
HighlighterBoundaryScannerFastVectorHighlighterOptionsStep<T>	boundaryMaxScan(int max)	Specify how far to scan for boundary characters when a characters boundary scanner is used.

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

end

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

locale

Method Detail

boundaryMaxScan

HighlighterBoundaryScannerFastVectorHighlighterOptionsStep<T> boundaryMaxScan(int max)

Specify how far to scan for boundary characters when a characters boundary scanner is used.

Specifying this value allows to include more text in the resulting fragment. After the highlighter highlighted a match and centered it based on the fragment size, it can additionally move the start/end positions of that fragment by looking for max characters to the left and to the right to find any boundary character. As soon as such character is found, it will become a new start/end position of the fragment. Otherwise, if boundary character is not found after moving for the max characters to the left/right - the original position determined after centering the match will be used.

Parameters:

max - The number of characters.

Returns:

The next step in a highlighter definition.

boundaryChars

HighlighterBoundaryScannerFastVectorHighlighterOptionsStep<T> boundaryChars(String boundaryChars)

Specify a set of characters to look for when scanning for boundaries when a characters boundary scanner is used.

Parameters:

boundaryChars - A string containing all boundary characters. The order doesn't matter: each character in the string will be considered as a boundary character.

Returns:

The next step in a highlighter definition.

boundaryChars

HighlighterBoundaryScannerFastVectorHighlighterOptionsStep<T> boundaryChars(Character[] boundaryChars)

Specify a set of characters to look for when scanning for boundaries when a characters boundary scanner is used.

Parameters:

boundaryChars - An array containing all boundary characters. The order doesn't matter: each character in the string will be considered as a boundary character.

Returns:

The next step in a highlighter definition.