Uses of Class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder (Lucene 10.5.0 highlighter API)
Description: use: package: org.apache.lucene.search.uhighlight, class: UnifiedHighlighter, class: Builder

# Uses of Class
org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder

Packages that use UnifiedHighlighter.Builder
Package
Description
org.apache.lucene.search.uhighlight
The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term vectors, or analysis.

- ## Uses of UnifiedHighlighter.Builder in org.apache.lucene.search.uhighlight

  Methods in org.apache.lucene.search.uhighlight that return UnifiedHighlighter.Builder
  Modifier and Type
  Method
  Description
  `static UnifiedHighlighter.Builder`
  UnifiedHighlighter.`builder(IndexSearcher searcher, Analyzer indexAnalyzer)`
  Creates a `UnifiedHighlighter.Builder` object where `IndexSearcher` and `Analyzer` are not null.
  `static UnifiedHighlighter.Builder`
  UnifiedHighlighter.`builderWithoutSearcher(Analyzer indexAnalyzer)`
  Creates a `UnifiedHighlighter.Builder` object in which you can only use `UnifiedHighlighter.highlightWithoutSearcher(String, Query, String, int)` for highlighting.
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withBreakIterator(Supplier<BreakIterator> value)`
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withCacheFieldValCharsThreshold(int value)`
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withFieldMatcher(Predicate<String> value)`
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withFlags(Set<UnifiedHighlighter.HighlightFlag> values)`
  User-defined set of `UnifiedHighlighter.HighlightFlag` values which will override the flags set by `withHandleMultiTermQuery(boolean)`, `withHighlightPhrasesStrictly(boolean)`, `withPassageRelevancyOverSpeed(boolean)` and `withWeightMatches(boolean)`.
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withFormatter(PassageFormatter value)`
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withHandleMultiTermQuery(boolean value)`
  Here `MultiTermQuery` derivatives will be highlighted.
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withHighlightPhrasesStrictly(boolean value)`
  Here position sensitive queries (e.g.
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withMaskedFieldsFunc(Function<String,Set<String>> maskedFieldsFunc)`
  Set up a function that given a field retuns a set of masked fields whose matches are combined to highlight the given field.
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withMaxLength(int value)`
  The text to be highlight is effectively truncated by this length.
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withMaxNoHighlightPassages(int value)`
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withPassageRelevancyOverSpeed(boolean value)`
  Passage relevancy is more important than speed.
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withPassageSortComparator(Comparator<Passage> value)`
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withScorer(PassageScorer value)`
  `UnifiedHighlighter.Builder`
  UnifiedHighlighter.Builder.`withWeightMatches(boolean value)`
  Internally use the `Weight.matches(LeafReaderContext, int)` API for highlighting.
  Methods in org.apache.lucene.search.uhighlight with parameters of type UnifiedHighlighter.Builder
  Modifier and Type
  Method
  Description
  `protected Set<UnifiedHighlighter.HighlightFlag>`
  UnifiedHighlighter.`evaluateFlags(UnifiedHighlighter.Builder uhBuilder)`
  Evaluate the highlight flags and set the `UnifiedHighlighter.flags` variable.
  Constructors in org.apache.lucene.search.uhighlight with parameters of type UnifiedHighlighter.Builder
  Modifier
  Constructor
  Description
  ``
  `UnifiedHighlighter(UnifiedHighlighter.Builder builder)`
  Constructs the highlighter with the given `UnifiedHighlighter.Builder`.