Uses of Class
org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
Packages that use UnifiedHighlighter.Builder
Package
Description
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.BuilderModifier and TypeMethodDescriptionstatic UnifiedHighlighter.BuilderUnifiedHighlighter.builder(IndexSearcher searcher, Analyzer indexAnalyzer) static UnifiedHighlighter.BuilderUnifiedHighlighter.builderWithoutSearcher(Analyzer indexAnalyzer) Creates aUnifiedHighlighter.Builderobject in which you can only useUnifiedHighlighter.highlightWithoutSearcher(String, Query, String, int)for highlighting.UnifiedHighlighter.Builder.withBreakIterator(Supplier<BreakIterator> value) UnifiedHighlighter.Builder.withCacheFieldValCharsThreshold(int value) UnifiedHighlighter.Builder.withFieldMatcher(Predicate<String> value) UnifiedHighlighter.Builder.withFlags(Set<UnifiedHighlighter.HighlightFlag> values) User-defined set ofUnifiedHighlighter.HighlightFlagvalues which will override the flags set bywithHandleMultiTermQuery(boolean),withHighlightPhrasesStrictly(boolean),withPassageRelevancyOverSpeed(boolean)andwithWeightMatches(boolean).UnifiedHighlighter.Builder.withFormatter(PassageFormatter value) UnifiedHighlighter.Builder.withHandleMultiTermQuery(boolean value) HereMultiTermQueryderivatives will be highlighted.UnifiedHighlighter.Builder.withHighlightPhrasesStrictly(boolean value) Here position sensitive queries (e.g.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.withMaxLength(int value) The text to be highlight is effectively truncated by this length.UnifiedHighlighter.Builder.withMaxNoHighlightPassages(int value) UnifiedHighlighter.Builder.withPassageRelevancyOverSpeed(boolean value) Passage relevancy is more important than speed.UnifiedHighlighter.Builder.withPassageSortComparator(Comparator<Passage> value) UnifiedHighlighter.Builder.withScorer(PassageScorer value) UnifiedHighlighter.Builder.withWeightMatches(boolean value) Internally use theWeight.matches(LeafReaderContext, int)API for highlighting.Methods in org.apache.lucene.search.uhighlight with parameters of type UnifiedHighlighter.BuilderModifier and TypeMethodDescriptionprotected Set<UnifiedHighlighter.HighlightFlag> UnifiedHighlighter.evaluateFlags(UnifiedHighlighter.Builder uhBuilder) Evaluate the highlight flags and set theUnifiedHighlighter.flagsvariable.Constructors in org.apache.lucene.search.uhighlight with parameters of type UnifiedHighlighter.BuilderModifierConstructorDescriptionConstructs the highlighter with the givenUnifiedHighlighter.Builder.