Class HighlighterFastVectorHighlighterOptionsStepImpl
- java.lang.Object
-
- org.hibernate.search.engine.search.highlighter.dsl.impl.HighlighterOptionsStepImpl<HighlighterFastVectorHighlighterOptionsStep>
-
- org.hibernate.search.engine.search.highlighter.dsl.impl.HighlighterFastVectorHighlighterOptionsStepImpl
-
- All Implemented Interfaces:
HighlighterFastVectorHighlighterOptionsStep,HighlighterFinalStep,HighlighterOptionsStep<HighlighterFastVectorHighlighterOptionsStep>
public class HighlighterFastVectorHighlighterOptionsStepImpl extends HighlighterOptionsStepImpl<HighlighterFastVectorHighlighterOptionsStep> implements HighlighterFastVectorHighlighterOptionsStep
-
-
Field Summary
-
Fields inherited from class org.hibernate.search.engine.search.highlighter.dsl.impl.HighlighterOptionsStepImpl
highlighterBuilder
-
-
Constructor Summary
Constructors Constructor Description HighlighterFastVectorHighlighterOptionsStepImpl(SearchHighlighterBuilder highlightBuilder)
-
Method Summary
-
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 Detail
-
HighlighterFastVectorHighlighterOptionsStepImpl
public HighlighterFastVectorHighlighterOptionsStepImpl(SearchHighlighterBuilder highlightBuilder)
-
-
Method Detail
-
phraseLimit
public HighlighterFastVectorHighlighterOptionsStep phraseLimit(int limit)
Description copied from interface:HighlighterFastVectorHighlighterOptionsStepSpecify the maximum number of matching phrases in a document that are considered for highlighting.- Specified by:
phraseLimitin interfaceHighlighterFastVectorHighlighterOptionsStep- Parameters:
limit- The maximum number of matching phrases.- Returns:
- The next step in a highlighter definition.
-
tags
public HighlighterFastVectorHighlighterOptionsStep tags(Collection<String> preTags, String postTag)
Description copied from interface:HighlighterFastVectorHighlighterOptionsStepAn alternative totag definition.Any previous calls to
HighlighterOptionsStep.tag(String, String)/HighlighterFastVectorHighlighterOptionsStep.tags(Collection, String)/HighlighterFastVectorHighlighterOptionsStep.tags(Collection, Collection)/HighlighterFastVectorHighlighterOptionsStep.tagSchema(HighlighterTagSchema)on this highlighter definition will be discarded and tags supplied here will be used.- Specified by:
tagsin interfaceHighlighterFastVectorHighlighterOptionsStep- 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
public HighlighterFastVectorHighlighterOptionsStep tags(Collection<String> preTags, Collection<String> postTags)
Description copied from interface:HighlighterFastVectorHighlighterOptionsStepAn alternative totag definition.Any previous calls to
HighlighterOptionsStep.tag(String, String)/HighlighterFastVectorHighlighterOptionsStep.tags(Collection, String)/HighlighterFastVectorHighlighterOptionsStep.tags(Collection, Collection)/HighlighterFastVectorHighlighterOptionsStep.tagSchema(HighlighterTagSchema)on this highlighter definition will be discarded and tags supplied here will be used.- Specified by:
tagsin interfaceHighlighterFastVectorHighlighterOptionsStep- 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
public HighlighterFastVectorHighlighterOptionsStep tagSchema(HighlighterTagSchema tagSchema)
Description copied from interface:HighlighterFastVectorHighlighterOptionsStepSpecify a set of predefined tags instead ofmanually supplying them.Any previous calls to
HighlighterOptionsStep.tag(String, String)/HighlighterFastVectorHighlighterOptionsStep.tags(Collection, String)/HighlighterFastVectorHighlighterOptionsStep.tags(Collection, Collection)on this highlighter definition will be discarded and tags from the predefined schema will be used.- Specified by:
tagSchemain interfaceHighlighterFastVectorHighlighterOptionsStep- Parameters:
tagSchema- The tag schema to apply.- Returns:
- The next step in a highlighter definition.
- See Also:
HighlighterTagSchema
-
boundaryScanner
public HighlighterBoundaryScannerTypeFastVectorHighlighterStep<? extends HighlighterFastVectorHighlighterOptionsStep> boundaryScanner()
Description copied from interface:HighlighterFastVectorHighlighterOptionsStepSpecify how the text should be broken up into highlighting snippets.By default, a
character boundary scanneris used.- Specified by:
boundaryScannerin interfaceHighlighterFastVectorHighlighterOptionsStep- Returns:
- The next step in a highlighter definition exposing boundary scanner specific options.
-
boundaryScanner
public HighlighterFastVectorHighlighterOptionsStep boundaryScanner(Consumer<? super HighlighterBoundaryScannerTypeFastVectorHighlighterStep<?>> boundaryScannerContributor)
Description copied from interface:HighlighterFastVectorHighlighterOptionsStepSpecify how the text should be broken up into highlighting snippets.By default, a
character boundary scanneris used.- Specified by:
boundaryScannerin interfaceHighlighterFastVectorHighlighterOptionsStep- 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.
-
-