Index (Lucene 10.5.1 highlighter API)

# Index

A B C D E F G H I L M N O P Q R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## A

accept(int, LeafReader, int, MatchRegionRetriever.FieldValueProvider, Map<String, List<OffsetRange>>) - Method in interface org.apache.lucene.search.matchhighlight.MatchRegionRetriever.MatchOffsetsConsumer
acceptPhrase(FieldPhraseList.WeightedPhraseInfo, int, int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragListBuilder
  A predicate to decide if the given `FieldPhraseList.WeightedPhraseInfo` should be accepted as a highlighted phrase or if it should be discarded.
add(int, int, List<FieldPhraseList.WeightedPhraseInfo>) - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList
  convert the list of WeightedPhraseInfo to WeightedFragInfo, then add it to the fragInfos
add(int, int, List<FieldPhraseList.WeightedPhraseInfo>) - Method in class org.apache.lucene.search.vectorhighlight.SimpleFieldFragList
add(int, int, List<FieldPhraseList.WeightedPhraseInfo>) - Method in class org.apache.lucene.search.vectorhighlight.WeightedFieldFragList
addIfNoOverlap(FieldPhraseList.WeightedPhraseInfo) - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList
addMatch(int, int, BytesRef, int) - Method in class org.apache.lucene.search.uhighlight.Passage
addPositionSpans(List<PositionSpan>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm
adjust(Passage) - Method in class org.apache.lucene.search.matchhighlight.BreakIteratorShrinkingAdjuster
adjust(Passage) - Method in interface org.apache.lucene.search.matchhighlight.PassageAdjuster
Algorithm - Search tag in package org.apache.lucene.search.vectorhighlight
  Section
allFragmentsProcessed() - Method in class org.apache.lucene.search.highlight.QueryTermScorer
alwaysFetchedFields() - Method in interface org.apache.lucene.search.matchhighlight.MatchHighlighter.FieldValueHighlighter
alwaysFetchFields(String...) - Method in class org.apache.lucene.search.matchhighlight.MatchHighlighter
  Always fetch the given set of fields for all input documents.
ANALYSIS - Enum constant in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.OffsetSource
AnalysisOffsetStrategy - Class in org.apache.lucene.search.uhighlight
  Provides a base class for analysis based offset strategies to extend from.
AnalysisOffsetStrategy(UHComponents, Analyzer) - Constructor for class org.apache.lucene.search.uhighlight.AnalysisOffsetStrategy
analyzer - Variable in class org.apache.lucene.search.uhighlight.AnalysisOffsetStrategy
append(StringBuilder, String, int, int) - Method in class org.apache.lucene.search.uhighlight.DefaultPassageFormatter
  Appends original text to the response.
appendFieldHighlighter(MatchHighlighter.FieldValueHighlighter) - Method in class org.apache.lucene.search.matchhighlight.MatchHighlighter
  Append a new highlighter to field highlighters chain.
automata() - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Returns the value of the `automata` record component.

## B

BaseFragListBuilder - Class in org.apache.lucene.search.vectorhighlight
  A abstract implementation of `FragListBuilder`.
BaseFragListBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.BaseFragListBuilder
BaseFragListBuilder(int) - Constructor for class org.apache.lucene.search.vectorhighlight.BaseFragListBuilder
BaseFragmentsBuilder - Class in org.apache.lucene.search.vectorhighlight
  Base FragmentsBuilder implementation that supports colored pre/post tags and multivalued fields.
BaseFragmentsBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
BaseFragmentsBuilder(String[], String[]) - Constructor for class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
BaseFragmentsBuilder(String[], String[], BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
BaseFragmentsBuilder(BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
boost() - Method in record class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo
  Returns the value of the `boost` record component.
boundaryChars - Variable in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
BoundaryScanner - Interface in org.apache.lucene.search.vectorhighlight
  Finds fragment boundaries: pluggable into `BaseFragmentsBuilder`
breakIterator - Variable in class org.apache.lucene.search.uhighlight.FieldHighlighter
BreakIteratorBoundaryScanner - Class in org.apache.lucene.search.vectorhighlight
  A `BoundaryScanner` implementation that uses `BreakIterator` to find boundaries in the text.
BreakIteratorBoundaryScanner(BreakIterator) - Constructor for class org.apache.lucene.search.vectorhighlight.BreakIteratorBoundaryScanner
BreakIteratorShrinkingAdjuster - Class in org.apache.lucene.search.matchhighlight
  A `PassageAdjuster` that adjusts the `Passage` range to word boundaries hinted by the given `BreakIterator`.
BreakIteratorShrinkingAdjuster() - Constructor for class org.apache.lucene.search.matchhighlight.BreakIteratorShrinkingAdjuster
BreakIteratorShrinkingAdjuster(BreakIterator) - Constructor for class org.apache.lucene.search.matchhighlight.BreakIteratorShrinkingAdjuster
build() - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
builder(IndexSearcher, Analyzer) - Static method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Creates a `UnifiedHighlighter.Builder` object where `IndexSearcher` and `Analyzer` are not null.
Builder(IndexSearcher, Analyzer) - Constructor for class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
  Constructor for UH builder which accepts `IndexSearcher` and `Analyzer` objects.
builderWithoutSearcher(Analyzer) - Static method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Creates a `UnifiedHighlighter.Builder` object in which you can only use `UnifiedHighlighter.highlightWithoutSearcher(String, Query, String, int)` for highlighting.

## C

CharArrayMatcher - Interface in org.apache.lucene.search.uhighlight
  Matches a character array
checkIntegrity() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
checkPosition(int) - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm
  Checks to see if this term is valid at `position`.
clone() - Method in class org.apache.lucene.search.matchhighlight.OffsetRange
clone() - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
close() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum
close() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.MultiOffsetsEnum
collectSpanQueryFields(SpanQuery, Set<String>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
COLORED_POST_TAGS - Static variable in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
COLORED_PRE_TAGS - Static variable in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
compare(FieldFragList.WeightedFragInfo, FieldFragList.WeightedFragInfo) - Method in class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder.ScoreComparator
compareTo(OffsetsEnum) - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum
compareTo(FieldPhraseList.WeightedPhraseInfo) - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
compareTo(FieldPhraseList.WeightedPhraseInfo.Toffs) - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs
compareTo(FieldTermStack.TermInfo) - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo
components - Variable in class org.apache.lucene.search.uhighlight.FieldOffsetStrategy
computeOffsetRetrievalStrategies(IndexReader, Analyzer) - Static method in class org.apache.lucene.search.matchhighlight.MatchRegionRetriever
  Compute default strategies for retrieving offsets from `MatchesIterator` instances for a set of given fields.
contains(OffsetRange) - Method in class org.apache.lucene.search.matchhighlight.OffsetRange
createClosestToLength(BreakIterator, int, float) - Static method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
  Breaks will be on average `targetLength` apart; the closest break to this target (before or after) is chosen.
createFieldFragList(FieldPhraseList, int) - Method in interface org.apache.lucene.search.vectorhighlight.FragListBuilder
  create a FieldFragList.
createFieldFragList(FieldPhraseList, int) - Method in class org.apache.lucene.search.vectorhighlight.SimpleFragListBuilder
createFieldFragList(FieldPhraseList, int) - Method in class org.apache.lucene.search.vectorhighlight.SingleFragListBuilder
createFieldFragList(FieldPhraseList, int) - Method in class org.apache.lucene.search.vectorhighlight.WeightedFragListBuilder
createFieldFragList(FieldPhraseList, FieldFragList, int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragListBuilder
createFragment(IndexReader, int, String, FieldFragList) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
createFragment(IndexReader, int, String, FieldFragList) - Method in interface org.apache.lucene.search.vectorhighlight.FragmentsBuilder
  create a fragment.
createFragment(IndexReader, int, String, FieldFragList, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
createFragment(IndexReader, int, String, FieldFragList, String[], String[], Encoder) - Method in interface org.apache.lucene.search.vectorhighlight.FragmentsBuilder
  create a fragment.
createFragments(IndexReader, int, String, FieldFragList, int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
createFragments(IndexReader, int, String, FieldFragList, int) - Method in interface org.apache.lucene.search.vectorhighlight.FragmentsBuilder
  create multiple fragments.
createFragments(IndexReader, int, String, FieldFragList, int, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
createFragments(IndexReader, int, String, FieldFragList, int, String[], String[], Encoder) - Method in interface org.apache.lucene.search.vectorhighlight.FragmentsBuilder
  create multiple fragments.
createMinLength(BreakIterator, int, float) - Static method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
  Breaks will be at least `minLength` apart (to the extent possible), while trying to position the match inside the fragment according to `fragmentAlignment`.
createOffsetsEnumFromReader(LeafReader, int) - Method in class org.apache.lucene.search.uhighlight.FieldOffsetStrategy
createOffsetsEnumsForAutomata(Terms, int, List<OffsetsEnum>) - Method in class org.apache.lucene.search.uhighlight.FieldOffsetStrategy
createOffsetsEnumsForSpans(LeafReader, int, List<OffsetsEnum>) - Method in class org.apache.lucene.search.uhighlight.PhraseHelper
  Given the internal SpanQueries, produce a number of OffsetsEnum into the `results` param.
createOffsetsEnumsForTerms(BytesRef[], Terms, int, List<OffsetsEnum>) - Method in class org.apache.lucene.search.uhighlight.FieldOffsetStrategy
createOffsetsEnumsWeightMatcher(LeafReader, int, List<OffsetsEnum>) - Method in class org.apache.lucene.search.uhighlight.FieldOffsetStrategy
current() - Method in class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator
current() - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
current() - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
current() - Method in class org.apache.lucene.search.uhighlight.WholeBreakIterator
currentField - Variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.LimitedStoredFieldVisitor
currentValue(CharSequence) - Method in class org.apache.lucene.search.matchhighlight.BreakIteratorShrinkingAdjuster
currentValue(CharSequence) - Method in interface org.apache.lucene.search.matchhighlight.PassageAdjuster
CustomSeparatorBreakIterator - Class in org.apache.lucene.search.uhighlight
  A `BreakIterator` that breaks the text whenever a certain separator, provided as a constructor argument, is found.
CustomSeparatorBreakIterator(char) - Constructor for class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator

## D

DEFAULT_BOUNDARY_CHARS - Static variable in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
DEFAULT_CACHE_CHARS_THRESHOLD - Static variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
DEFAULT_FIELD_MATCH - Static variable in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
DEFAULT_MAX_CHARS_TO_ANALYZE - Static variable in class org.apache.lucene.search.highlight.Highlighter
DEFAULT_MAX_LENGTH - Static variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
DEFAULT_MAX_SCAN - Static variable in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
DEFAULT_PHRASE_HIGHLIGHT - Static variable in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
DEFAULT_SCORER - Static variable in class org.apache.lucene.search.matchhighlight.PassageSelector
DefaultEncoder - Class in org.apache.lucene.search.highlight
  Simple `Encoder` implementation that does not modify the output
DefaultEncoder() - Constructor for class org.apache.lucene.search.highlight.DefaultEncoder
DefaultPassageFormatter - Class in org.apache.lucene.search.uhighlight
  Creates a formatted snippet from the top passages.
DefaultPassageFormatter() - Constructor for class org.apache.lucene.search.uhighlight.DefaultPassageFormatter
  Creates a new DefaultPassageFormatter with the default tags.
DefaultPassageFormatter(String, String, String, boolean) - Constructor for class org.apache.lucene.search.uhighlight.DefaultPassageFormatter
  Creates a new DefaultPassageFormatter with custom tags.
defaultPassageSelector() - Static method in class org.apache.lucene.search.matchhighlight.FieldValueHighlighters
  Default preconfigured `PassageSelector`.
discreteMultiValueHighlighting(List<FieldFragList.WeightedFragInfo>, Field[]) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
DocHighlights(int) - Constructor for class org.apache.lucene.search.matchhighlight.MatchHighlighter.DocHighlights
docId - Variable in class org.apache.lucene.search.matchhighlight.MatchHighlighter.DocHighlights
doClose() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader

## E

ellipsis - Variable in class org.apache.lucene.search.uhighlight.DefaultPassageFormatter
  text that will appear between two unconnected passages
EMPTY - Static variable in class org.apache.lucene.search.uhighlight.OffsetsEnum
  Empty enumeration
Encoder - Interface in org.apache.lucene.search.highlight
  Encodes original text.
encodeText(String) - Method in class org.apache.lucene.search.highlight.DefaultEncoder
encodeText(String) - Method in interface org.apache.lucene.search.highlight.Encoder
encodeText(String) - Method in class org.apache.lucene.search.highlight.SimpleHTMLEncoder
endOffset() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum
endOffset() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.MultiOffsetsEnum
endOffset() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIterator
endOffset() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIteratorWithSubs
endOffset() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfPostings
equals(Object) - Method in class org.apache.lucene.search.matchhighlight.OffsetRange
equals(Object) - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
equals(Object) - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs
equals(Object) - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo
escape - Variable in class org.apache.lucene.search.uhighlight.DefaultPassageFormatter
  true if we should escape for html
evaluateFlags(boolean, boolean, boolean, boolean) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  This method returns the set of of `UnifiedHighlighter.HighlightFlag`s, which will be applied to the UH object.
evaluateFlags(UnifiedHighlighter) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
evaluateFlags(UnifiedHighlighter.Builder) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Evaluate the highlight flags and set the `UnifiedHighlighter.flags` variable.
Example Usage - Search tag in package org.apache.lucene.search.highlight
  Section
extract(Query, float, Map<String, WeightedSpanTerm>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Fills a `Map` with `WeightedSpanTerm`s using the terms from the supplied `Query`.
extractTerms(Query) - Static method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Extracts matching terms
extractUnknownQuery(Query, Map<String, WeightedSpanTerm>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
extractWeightedSpanTerms(Map<String, WeightedSpanTerm>, SpanQuery, float) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Fills a `Map` with `WeightedSpanTerm`s using the terms from the supplied `SpanQuery`.
extractWeightedTerms(Map<String, WeightedSpanTerm>, Query, float) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Fills a `Map` with `WeightedSpanTerm`s using the terms from the supplied `Query`.

## F

FastVectorHighlighter - Class in org.apache.lucene.search.vectorhighlight
  Another highlighter implementation.
FastVectorHighlighter() - Constructor for class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  the default constructor.
FastVectorHighlighter(boolean, boolean) - Constructor for class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  a constructor.
FastVectorHighlighter(boolean, boolean, FragListBuilder, FragmentsBuilder) - Constructor for class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  a constructor.
Features - Search tag in package org.apache.lucene.search.vectorhighlight
  Section
field - Variable in class org.apache.lucene.search.uhighlight.FieldHighlighter
field() - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Returns the value of the `field` record component.
FieldFragList - Class in org.apache.lucene.search.vectorhighlight
  FieldFragList has a list of "frag info" that is used by FragmentsBuilder class to create fragments (snippets).
FieldFragList(int) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldFragList
  a constructor.
FieldFragList.WeightedFragInfo - Class in org.apache.lucene.search.vectorhighlight
  List of term offsets + weight for a frag info
FieldFragList.WeightedFragInfo.SubInfo - Record Class in org.apache.lucene.search.vectorhighlight
  Represents the list of term offsets for some text
FieldHighlighter - Class in org.apache.lucene.search.uhighlight
  Internal highlighter abstraction that operates on a per field basis.
FieldHighlighter(String, FieldOffsetStrategy, BreakIterator, PassageScorer, int, int, PassageFormatter, Comparator<Passage>) - Constructor for class org.apache.lucene.search.uhighlight.FieldHighlighter
fieldInfos - Variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
fieldMatch - Variable in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
fieldMatcher() - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Returns the value of the `fieldMatcher` record component.
fieldNameComparator(String) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Necessary to implement matches for queries against `defaultField`
fieldOffsetStrategy - Variable in class org.apache.lucene.search.uhighlight.FieldHighlighter
FieldOffsetStrategy - Class in org.apache.lucene.search.uhighlight
  Ultimately returns an `OffsetsEnum` yielding potentially highlightable words in the text.
FieldOffsetStrategy(UHComponents) - Constructor for class org.apache.lucene.search.uhighlight.FieldOffsetStrategy
FieldPhraseList - Class in org.apache.lucene.search.vectorhighlight
  FieldPhraseList has a list of WeightedPhraseInfo that is used by FragListBuilder to create a FieldFragList object.
FieldPhraseList(FieldPhraseList[]) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList
  Merging constructor.
FieldPhraseList(FieldTermStack, FieldQuery) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList
  create a FieldPhraseList that has no limit on the number of phrases to analyze
FieldPhraseList(FieldTermStack, FieldQuery, int) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList
  a constructor.
FieldPhraseList.WeightedPhraseInfo - Class in org.apache.lucene.search.vectorhighlight
  Represents the list of term offsets and boost for some text
FieldPhraseList.WeightedPhraseInfo.Toffs - Class in org.apache.lucene.search.vectorhighlight
  Term offsets (start + end)
FieldQuery - Class in org.apache.lucene.search.vectorhighlight
  FieldQuery breaks down query object into terms/phrases and keeps them in a QueryPhraseMap structure.
FieldQuery(Query, IndexReader, boolean, boolean) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldQuery
FieldQuery.QueryPhraseMap - Class in org.apache.lucene.search.vectorhighlight
  Internal structure of a query for highlighting: represents a nested query structure
fields - Variable in class org.apache.lucene.search.matchhighlight.MatchHighlighter.DocHighlights
fields - Variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.LimitedStoredFieldVisitor
FieldTermStack - Class in org.apache.lucene.search.vectorhighlight
  `FieldTermStack` is a stack that keeps query terms in the specified field of the document to be highlighted.
FieldTermStack(IndexReader, int, String, FieldQuery) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldTermStack
  a constructor.
FieldTermStack.TermInfo - Class in org.apache.lucene.search.vectorhighlight
  Single term with its position/offsets in the document and IDF weight.
FieldValueHighlighters - Class in org.apache.lucene.search.matchhighlight
  A factory of `MatchHighlighter.FieldValueHighlighter` classes that cover typical use cases (verbatim values, highlights, abbreviations).
filterExtractedTerms(Predicate<String>, Set<Term>) - Static method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
findEndOffset(StringBuilder, int) - Method in interface org.apache.lucene.search.vectorhighlight.BoundaryScanner
  Scan forward to find start offset.
findEndOffset(StringBuilder, int) - Method in class org.apache.lucene.search.vectorhighlight.BreakIteratorBoundaryScanner
findEndOffset(StringBuilder, int) - Method in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
findStartOffset(StringBuilder, int) - Method in interface org.apache.lucene.search.vectorhighlight.BoundaryScanner
  Scan backward to find end offset.
findStartOffset(StringBuilder, int) - Method in class org.apache.lucene.search.vectorhighlight.BreakIteratorBoundaryScanner
findStartOffset(StringBuilder, int) - Method in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
first() - Method in class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator
first() - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
first() - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
first() - Method in class org.apache.lucene.search.uhighlight.WholeBreakIterator
flatten(Query, IndexSearcher, Collection<Query>, float) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery
following(int) - Method in class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator
following(int) - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
following(int) - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
following(int) - Method in class org.apache.lucene.search.uhighlight.WholeBreakIterator
follows(TextFragment) - Method in class org.apache.lucene.search.highlight.TextFragment
format(CharSequence, List<Passage>, List<OffsetRange>) - Method in class org.apache.lucene.search.matchhighlight.PassageFormatter
format(StringBuilder, CharSequence, Passage) - Method in class org.apache.lucene.search.matchhighlight.PassageFormatter
format(String, List<String>, String, List<OffsetRange>, List<MatchHighlighter.QueryOffsetRange>) - Method in interface org.apache.lucene.search.matchhighlight.MatchHighlighter.FieldValueHighlighter
  Format field values into a list of final "highlights".
format(Passage[], String) - Method in class org.apache.lucene.search.uhighlight.DefaultPassageFormatter
format(Passage[], String) - Method in class org.apache.lucene.search.uhighlight.PassageFormatter
  Formats the top `passages` from `content` into a human-readable text snippet.
Formatter - Interface in org.apache.lucene.search.highlight
  Processes terms found in the original text, typically by applying some form of mark-up to highlight terms in HTML search results pages.
FragListBuilder - Interface in org.apache.lucene.search.vectorhighlight
  FragListBuilder is an interface for FieldFragList builder classes.
Fragmenter - Interface in org.apache.lucene.search.highlight
  Implements the policy for breaking text into multiple fragments for consideration by the `Highlighter` class.
FragmentsBuilder - Interface in org.apache.lucene.search.vectorhighlight
  `FragmentsBuilder` is an interface for fragments (snippets) builder classes.
freq() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum
  An estimate of the number of occurrences of this term/OffsetsEnum.
freq() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.MultiOffsetsEnum
freq() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIterator
freq() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIteratorWithSubs
freq() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfPostings
from - Variable in class org.apache.lucene.search.matchhighlight.OffsetRange
  Start index, inclusive.
fromTerms(List<BytesRef>) - Static method in interface org.apache.lucene.search.uhighlight.CharArrayMatcher

## G

get(MatchesIterator, MatchRegionRetriever.FieldValueProvider) - Method in class org.apache.lucene.search.matchhighlight.OffsetsFromMatchIterator
get(MatchesIterator, MatchRegionRetriever.FieldValueProvider) - Method in class org.apache.lucene.search.matchhighlight.OffsetsFromPositions
get(MatchesIterator, MatchRegionRetriever.FieldValueProvider) - Method in class org.apache.lucene.search.matchhighlight.OffsetsFromTokens
get(MatchesIterator, MatchRegionRetriever.FieldValueProvider) - Method in class org.apache.lucene.search.matchhighlight.OffsetsFromValues
get(MatchesIterator, MatchRegionRetriever.FieldValueProvider) - Method in interface org.apache.lucene.search.matchhighlight.OffsetsRetrievalStrategy
  Return value offsets (match ranges) acquired from the given `MatchesIterator`.
getAllPositionInsensitiveTerms() - Method in class org.apache.lucene.search.uhighlight.PhraseHelper
  Returns the terms that are position-insensitive (sorted).
getAnyTokenStream(IndexReader, int, String, Analyzer) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Deprecated.
getAnyTokenStream(IndexReader, int, String, Document, Analyzer) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Deprecated.
getAutomata(String, Query, Set<UnifiedHighlighter.HighlightFlag>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
getBackgroundColorString(float) - Method in class org.apache.lucene.search.highlight.GradientFormatter
getBestFragment(Analyzer, String, String) - Method in class org.apache.lucene.search.highlight.Highlighter
  Highlights chosen terms in a text, extracting the most relevant section.
getBestFragment(TokenStream, String) - Method in class org.apache.lucene.search.highlight.Highlighter
  Highlights chosen terms in a text, extracting the most relevant section.
getBestFragment(FieldQuery, IndexReader, int, String, int) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  return the best fragment.
getBestFragment(FieldQuery, IndexReader, int, String, int, FragListBuilder, FragmentsBuilder, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  return the best fragment.
getBestFragments(Analyzer, String, String, int) - Method in class org.apache.lucene.search.highlight.Highlighter
  Highlights chosen terms in a text, extracting the most relevant sections.
getBestFragments(TokenStream, String, int) - Method in class org.apache.lucene.search.highlight.Highlighter
  Highlights chosen terms in a text, extracting the most relevant sections.
getBestFragments(TokenStream, String, int, String) - Method in class org.apache.lucene.search.highlight.Highlighter
  Highlights terms in the text , extracting the most relevant sections and concatenating the chosen fragments with a separator (typically "...").
getBestFragments(FieldQuery, IndexReader, int, String, int, int) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  return the best fragments.
getBestFragments(FieldQuery, IndexReader, int, String, int, int, FragListBuilder, FragmentsBuilder, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  return the best fragments.
getBestFragments(FieldQuery, IndexReader, int, String, Set<String>, int, int, FragListBuilder, FragmentsBuilder, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  Return the best fragments.
getBestTextFragments(TokenStream, String, boolean, int) - Method in class org.apache.lucene.search.highlight.Highlighter
  Low level api to get the most relevant (formatted) sections of the document.
getBinaryDocValues(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getBoost() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
getBoost() - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap
getBreakIterator(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Returns the `BreakIterator` to use for dividing text into passages.
getByteVectorValues(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getCacheFieldValCharsThreshold() - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Limits the amount of field value pre-fetching until this threshold is passed.
getCoreCacheHelper() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getCoreCacheHelper() - Method in class org.apache.lucene.search.uhighlight.OverlaySingleDocTermsLeafReader
getDocValuesSkipper(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getEncoder() - Method in class org.apache.lucene.search.highlight.Highlighter
getEndOffset() - Method in class org.apache.lucene.search.highlight.TokenGroup
getEndOffset() - Method in class org.apache.lucene.search.uhighlight.Passage
  End offset of this passage.
getEndOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo
getEndOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
getEndOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs
getEndOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo
getExpandMultiTermQuery() - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
getField() - Method in class org.apache.lucene.search.uhighlight.FieldHighlighter
getField() - Method in class org.apache.lucene.search.uhighlight.FieldOffsetStrategy
getField() - Method in class org.apache.lucene.search.uhighlight.MultiFieldsOffsetStrategy
getFieldHighlighter(String, Query, Set<Term>, int) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
getFieldInfo(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Called by the default implementation of `UnifiedHighlighter.getOffsetSource(String)`.
getFieldInfos() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getFieldMatcher(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Returns the predicate to use for extracting the query part that must be highlighted.
getFieldName() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack
getFieldQuery(Query) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  create a `FieldQuery` object.
getFieldQuery(Query, IndexReader) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  create a `FieldQuery` object.
getFields(IndexReader, int, String) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
getFieldTermMap(String, String) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery
getFlags() - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
getFlags(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Returns the `UnifiedHighlighter.HighlightFlag`s applicable for the current UH instance.
getFloatVectorValues(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getForegroundColorString(float) - Method in class org.apache.lucene.search.highlight.GradientFormatter
getFormatter(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Returns the `PassageFormatter` to use for formatting passages into highlighted snippets.
getFragInfos() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList
  return the list of WeightedFragInfos.
getFragmentScore() - Method in class org.apache.lucene.search.highlight.QueryScorer
getFragmentScore() - Method in class org.apache.lucene.search.highlight.QueryTermScorer
getFragmentScore() - Method in interface org.apache.lucene.search.highlight.Scorer
  Called when the `Highlighter` has no more tokens for the current fragment - the Scorer returns the weighting it has derived for the most recent fragment, typically based on the results of `Scorer.getTokenScore()`.
getFragmentScorer() - Method in class org.apache.lucene.search.highlight.Highlighter
getFragmentSize() - Method in class org.apache.lucene.search.highlight.SimpleFragmenter
getFragmentSource(StringBuilder, int[], Field[], int, int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
getFragmentSourceMSO(StringBuilder, int[], Field[], int, int, int[]) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
getFragNum() - Method in class org.apache.lucene.search.highlight.TextFragment
getHighlightComponents(String, Query, Set<Term>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
getIdfWeightedTerms(Query, IndexReader, String) - Static method in class org.apache.lucene.search.highlight.QueryTermExtractor
  Extracts all terms texts of a given Query into an array of WeightedTerms
getIndexAnalyzer() - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
  ...
getIndexAnalyzer() - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  ...
getIndexSearcher() - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
  ...
getIndexSearcher() - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  ...
getLabel() - Method in interface org.apache.lucene.search.uhighlight.LabelledCharArrayMatcher
getLeafContext() - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
getLength() - Method in class org.apache.lucene.search.uhighlight.Passage
getLiveDocs() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getMaskedFields(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
getMatchEnds() - Method in class org.apache.lucene.search.uhighlight.Passage
  End offsets of the term matches, corresponding with `Passage.getMatchStarts()`.
getMatchStarts() - Method in class org.apache.lucene.search.uhighlight.Passage
  Start offsets of the term matches, in increasing order.
getMatchTermFreqsInDoc() - Method in class org.apache.lucene.search.uhighlight.Passage
getMatchTerms() - Method in class org.apache.lucene.search.uhighlight.Passage
  BytesRef (term text) of the matches, corresponding with `Passage.getMatchStarts()`.
getMaxDocCharsToAnalyze() - Method in class org.apache.lucene.search.highlight.Highlighter
getMaxLength() - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  The maximum content size to process.
getMaxNoHighlightPassages(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Returns the number of leading passages (as delineated by the `BreakIterator`) when no highlights could be found.
getMaxTermWeight() - Method in class org.apache.lucene.search.highlight.QueryScorer
getMaxTermWeight() - Method in class org.apache.lucene.search.highlight.QueryTermScorer
getMetaData() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getMultiValuedSeparator() - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
getNext() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo
  Returns the next TermInfo at this same position.
getNormValues(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getNumericDocValues(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getNumMatches() - Method in class org.apache.lucene.search.uhighlight.Passage
  Number of term matches available in `Passage.getMatchStarts()`, `Passage.getMatchEnds()`, `Passage.getMatchTerms()`
getNumTokens() - Method in class org.apache.lucene.search.highlight.TokenGroup
getOffsetsEnum(LeafReader, int, String) - Method in class org.apache.lucene.search.uhighlight.FieldOffsetStrategy
  The primary method -- return offsets for highlightable words in the specified document.
getOffsetsEnum(LeafReader, int, String) - Method in class org.apache.lucene.search.uhighlight.MemoryIndexOffsetStrategy
getOffsetsEnum(LeafReader, int, String) - Method in class org.apache.lucene.search.uhighlight.MultiFieldsOffsetStrategy
getOffsetsEnum(LeafReader, int, String) - Method in class org.apache.lucene.search.uhighlight.NoOpOffsetStrategy
getOffsetsEnum(LeafReader, int, String) - Method in class org.apache.lucene.search.uhighlight.PostingsOffsetStrategy
getOffsetsEnum(LeafReader, int, String) - Method in class org.apache.lucene.search.uhighlight.PostingsWithTermVectorsOffsetStrategy
getOffsetsEnum(LeafReader, int, String) - Method in class org.apache.lucene.search.uhighlight.TermVectorOffsetStrategy
getOffsetsEnum(LeafReader, int, String) - Method in class org.apache.lucene.search.uhighlight.TokenStreamOffsetStrategy
getOffsetSource() - Method in class org.apache.lucene.search.uhighlight.AnalysisOffsetStrategy
getOffsetSource() - Method in class org.apache.lucene.search.uhighlight.FieldHighlighter
getOffsetSource() - Method in class org.apache.lucene.search.uhighlight.FieldOffsetStrategy
getOffsetSource() - Method in class org.apache.lucene.search.uhighlight.MultiFieldsOffsetStrategy
getOffsetSource() - Method in class org.apache.lucene.search.uhighlight.NoOpOffsetStrategy
getOffsetSource() - Method in class org.apache.lucene.search.uhighlight.PostingsOffsetStrategy
getOffsetSource() - Method in class org.apache.lucene.search.uhighlight.PostingsWithTermVectorsOffsetStrategy
getOffsetSource() - Method in class org.apache.lucene.search.uhighlight.TermVectorOffsetStrategy
getOffsetSource(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Determine the offset source for the specified field.
getOffsetStrategy(UnifiedHighlighter.OffsetSource, UHComponents) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
getOptimizedOffsetSource(UHComponents) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
getPassageSortComparator(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Returns the `Comparator` to use for finally sorting passages.
getPhraseHelper(String, Query, Set<UnifiedHighlighter.HighlightFlag>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
getPhraseLimit() - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
getPhraseList() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList
  return the list of WeightedPhraseInfo.
getPointValues(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getPosition() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo
getPositionSpans() - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm
getPostingsEnum() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfPostings
getPostTag(int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
getPostTag(String[], int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
getPreTag(int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
getPreTag(String[], int) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
getReaderCacheHelper() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getReaderCacheHelper() - Method in class org.apache.lucene.search.uhighlight.OverlaySingleDocTermsLeafReader
getScore() - Method in class org.apache.lucene.search.highlight.TextFragment
getScore() - Method in class org.apache.lucene.search.uhighlight.Passage
  Passage's score.
getScore(int) - Method in class org.apache.lucene.search.highlight.TokenGroup
getScorer(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Returns the `PassageScorer` to use for ranking passages.
getSeqnum() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
getSlop() - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap
getSortedDocValues(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getSortedNumericDocValues(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getSortedSetDocValues(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
getSpanQueries() - Method in class org.apache.lucene.search.uhighlight.PhraseHelper
getStartOffset() - Method in class org.apache.lucene.search.highlight.TokenGroup
getStartOffset() - Method in class org.apache.lucene.search.uhighlight.Passage
  Start offset of this passage.
getStartOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo
getStartOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
getStartOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs
getStartOffset() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo
getSubInfos() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo
getSummaryPassagesNoHighlight(int) - Method in class org.apache.lucene.search.uhighlight.FieldHighlighter
  Called to summarize a document when no highlights were found.
getTerm() - Method in class org.apache.lucene.search.highlight.WeightedTerm
getTerm() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum
  The term at this position.
getTerm() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.MultiOffsetsEnum
getTerm() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIterator
getTerm() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIteratorWithSubs
getTerm() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfPostings
getTermMap(String) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap
getTermOrPhraseNumber() - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap
getTerms(Query) - Static method in class org.apache.lucene.search.highlight.QueryTermExtractor
  Extracts all terms texts of a given Query into an array of WeightedTerms
getTerms(Query, boolean) - Static method in class org.apache.lucene.search.highlight.QueryTermExtractor
  Extracts all terms texts of a given Query into an array of WeightedTerms
getTerms(Query, boolean, String) - Static method in class org.apache.lucene.search.highlight.QueryTermExtractor
  Extracts all terms texts of a given Query into an array of WeightedTerms
getTermsInfos() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
getTermsOffsets() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
getTermVectorTerms() - Method in class org.apache.lucene.search.highlight.TokenStreamFromTermVector
getTermVectorTokenStreamOrNull(String, Fields, int) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Get a token stream by un-inverting the term vector.
getText() - Method in class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator
getText() - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
getText() - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
getText() - Method in class org.apache.lucene.search.uhighlight.WholeBreakIterator
getText() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
  Text of the match, calculated on the fly.
getText() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo
getTextFragmenter() - Method in class org.apache.lucene.search.highlight.Highlighter
getTokenScore() - Method in class org.apache.lucene.search.highlight.QueryScorer
getTokenScore() - Method in class org.apache.lucene.search.highlight.QueryTermScorer
getTokenScore() - Method in interface org.apache.lucene.search.highlight.Scorer
  Called for each token in the current fragment.
getTokenStream() - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Returns the tokenStream which may have been wrapped in a CachingTokenFilter.
getTokenStream(String, String, Analyzer) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Deprecated.
getTokenStream(String, Fields, String, Analyzer, int) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Get a token stream from either un-inverting a term vector if possible, or by analyzing the text.
getTokenStream(Document, String, Analyzer) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Deprecated.
getTokenStream(IndexReader, int, String, Analyzer) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Deprecated.
getTokenStream(Terms) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Deprecated.
getTokenStream(Terms, boolean) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Deprecated.
getTokenStreamWithOffsets(IndexReader, int, String) - Static method in class org.apache.lucene.search.highlight.TokenSources
  Deprecated.
getTotalBoost() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo
getTotalScore() - Method in class org.apache.lucene.search.highlight.TokenGroup
getValues(String) - Method in interface org.apache.lucene.search.matchhighlight.MatchRegionRetriever.FieldValueProvider
getWeight() - Method in class org.apache.lucene.search.highlight.WeightedTerm
getWeight() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo
getWeightedFragInfoList(List<FieldFragList.WeightedFragInfo>) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
getWeightedFragInfoList(List<FieldFragList.WeightedFragInfo>) - Method in class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder
  Sort by score the list of WeightedFragInfo
getWeightedFragInfoList(List<FieldFragList.WeightedFragInfo>) - Method in class org.apache.lucene.search.vectorhighlight.SimpleFragmentsBuilder
  do nothing.
getWeightedSpanTerm(String) - Method in class org.apache.lucene.search.highlight.QueryScorer
  Retrieve the `WeightedSpanTerm` for the specified token.
getWeightedSpanTerms(Query, float, TokenStream) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Creates a Map of `WeightedSpanTerms` from the given `Query` and `TokenStream`.
getWeightedSpanTerms(Query, float, TokenStream, String) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Creates a Map of `WeightedSpanTerms` from the given `Query` and `TokenStream`.
getWeightedSpanTermsWithScores(Query, float, TokenStream, String, IndexReader) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  Creates a Map of `WeightedSpanTerms` from the given `Query` and `TokenStream`.
GradientFormatter - Class in org.apache.lucene.search.highlight
  Formats text with different color intensity depending on the score of the term.
GradientFormatter(float, String, String, String, String) - Constructor for class org.apache.lucene.search.highlight.GradientFormatter
  Sets the color range for the IDF scores

## H

hashCode() - Method in class org.apache.lucene.search.matchhighlight.OffsetRange
hashCode() - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Returns a hash code value for this object.
hashCode() - Method in record class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo
  Returns a hash code value for this object.
hashCode() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
hashCode() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs
hashCode() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo
hasPositionSensitivity() - Method in class org.apache.lucene.search.uhighlight.PhraseHelper
  If there is no position sensitivity then use of the instance of this class can be ignored.
hasUnrecognizedQuery(Predicate<String>, Query) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
hasUnrecognizedQueryPart() - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Returns the value of the `hasUnrecognizedQueryPart` record component.
hexToInt(String) - Static method in class org.apache.lucene.search.highlight.GradientFormatter
  Converts a hex string into an int.
highlight(String, Query, TopDocs) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Highlights the top passages from a single field.
highlight(String, Query, TopDocs, int) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Highlights the top-N passages from a single field.
highlight(TopDocs, Query...) - Method in class org.apache.lucene.search.matchhighlight.MatchHighlighter
highlightBackground - Variable in class org.apache.lucene.search.highlight.GradientFormatter
highlightDocument(LeafReaderContext, int, MatchRegionRetriever.FieldValueProvider, ToIntFunction<String>, Map<String, List<OffsetRange>>) - Method in class org.apache.lucene.search.matchhighlight.MatchRegionRetriever
  Low-level method for retrieving hit ranges for a single document.
highlightDocuments(PrimitiveIterator.OfInt, MatchRegionRetriever.MatchOffsetsConsumer, ToIntFunction<String>) - Method in class org.apache.lucene.search.matchhighlight.MatchRegionRetriever
  Low-level, high-efficiency method for highlighting large numbers of documents at once.
highlightDocuments(PrimitiveIterator.OfInt, MatchRegionRetriever.MatchOffsetsConsumer, ToIntFunction<String>, int, int) - Method in class org.apache.lucene.search.matchhighlight.MatchRegionRetriever
  Low-level, high-efficiency method for highlighting large numbers of documents at once.
highlightDocuments(TopDocs, MatchRegionRetriever.MatchOffsetsConsumer) - Method in class org.apache.lucene.search.matchhighlight.MatchRegionRetriever
  Processes `TopDocs` with reasonable defaults.
highlighted(int, int, PassageFormatter, Predicate<String>) - Static method in class org.apache.lucene.search.matchhighlight.FieldValueHighlighters
  Highlights fields matching predicate `matchFields` only if they contained query matches.
Highlighter - Class in org.apache.lucene.search.highlight
  Marks up highlighted terms found in the best sections of text, using configurable `Fragmenter`, `Scorer`, `Formatter`, `Encoder` and tokenizers.
Highlighter(Formatter, Encoder, Scorer) - Constructor for class org.apache.lucene.search.highlight.Highlighter
Highlighter(Formatter, Scorer) - Constructor for class org.apache.lucene.search.highlight.Highlighter
Highlighter(Scorer) - Constructor for class org.apache.lucene.search.highlight.Highlighter
highlightFieldForDoc(LeafReader, int, String) - Method in class org.apache.lucene.search.uhighlight.FieldHighlighter
  The primary method -- highlight this doc, assuming a specific field and given this content.
highlightFields(String[], Query, int[], int[]) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Highlights the top-N passages from multiple fields, for the provided int[] docids.
highlightFields(String[], Query, TopDocs) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Highlights the top passages from multiple fields.
highlightFields(String[], Query, TopDocs, int[]) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Highlights the top-N passages from multiple fields.
highlightFieldsAsObjects(String[], Query, int[], int[]) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Expert: highlights the top-N passages from multiple fields, for the provided int[] docids, to custom Object as returned by the `PassageFormatter`.
highlightFlags() - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Returns the value of the `highlightFlags` record component.
highlightForeground - Variable in class org.apache.lucene.search.highlight.GradientFormatter
highlightOffsetsEnums(OffsetsEnum) - Method in class org.apache.lucene.search.uhighlight.FieldHighlighter
highlightTerm(String, TokenGroup) - Method in interface org.apache.lucene.search.highlight.Formatter
highlightTerm(String, TokenGroup) - Method in class org.apache.lucene.search.highlight.GradientFormatter
highlightTerm(String, TokenGroup) - Method in class org.apache.lucene.search.highlight.SimpleHTMLFormatter
highlightTerm(String, TokenGroup) - Method in class org.apache.lucene.search.highlight.SpanGradientFormatter
highlightWithoutSearcher(String, Query, String, int) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Highlights text passed as a parameter.
htmlEncode(String) - Static method in class org.apache.lucene.search.highlight.SimpleHTMLEncoder
  Encode string into HTML

## I

incrementToken() - Method in class org.apache.lucene.search.highlight.OffsetLimitTokenFilter
incrementToken() - Method in class org.apache.lucene.search.highlight.TokenStreamFromTermVector
indexAnalyzer - Variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
init(TokenStream) - Method in class org.apache.lucene.search.highlight.QueryScorer
init(TokenStream) - Method in class org.apache.lucene.search.highlight.QueryTermScorer
init(TokenStream) - Method in interface org.apache.lucene.search.highlight.Scorer
  Called to init the Scorer with a `TokenStream`.
INSTANCE - Static variable in class org.apache.lucene.search.uhighlight.NoOpOffsetStrategy
InvalidTokenOffsetsException - Exception Class in org.apache.lucene.search.highlight
  Exception thrown if TokenStream Tokens are incompatible with provided text
InvalidTokenOffsetsException(String) - Constructor for exception class org.apache.lucene.search.highlight.InvalidTokenOffsetsException
isApplicable(String, boolean) - Method in interface org.apache.lucene.search.matchhighlight.MatchHighlighter.FieldValueHighlighter
  Check if this highlighter can be applied to a given field.
isBoundary(int) - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
isCachedTokenStream() - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
isDiscreteMultiValueHighlighting() - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
isEmpty() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack
  to know whether the stack is empty
isExpandMultiTermQuery() - Method in class org.apache.lucene.search.highlight.QueryScorer
isFieldMatch() - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  return whether fieldMatch or not.
isNewFragment() - Method in interface org.apache.lucene.search.highlight.Fragmenter
  Test to see if this token from the stream should be held in a new TextFragment.
isNewFragment() - Method in class org.apache.lucene.search.highlight.NullFragmenter
isNewFragment() - Method in class org.apache.lucene.search.highlight.SimpleFragmenter
isNewFragment() - Method in class org.apache.lucene.search.highlight.SimpleSpanFragmenter
isOffsetOverlap(FieldPhraseList.WeightedPhraseInfo) - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
isPhraseHighlight() - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  return whether phraseHighlight or not.
isPositionSensitive() - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm
isQueryUnsupported(Class<? extends Query>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
isTerminal() - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap
isUsePayloads() - Method in class org.apache.lucene.search.highlight.QueryScorer
  Whether or not we should capture payloads in `MemoryIndex` at each position so that queries can access them.
isUsePayloads() - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
isValidTermOrPhrase(List<FieldTermStack.TermInfo>) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap

## L

LabelledCharArrayMatcher - Interface in org.apache.lucene.search.uhighlight
  Associates a label with a CharArrayMatcher to distinguish different sources for terms in highlighting
last() - Method in class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator
last() - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
last() - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
last() - Method in class org.apache.lucene.search.uhighlight.WholeBreakIterator
length() - Method in class org.apache.lucene.search.matchhighlight.OffsetRange
LengthGoalBreakIterator - Class in org.apache.lucene.search.uhighlight
  Wraps another `BreakIterator` to skip past breaks that would result in passages that are too short.
LimitedStoredFieldVisitor(String[], char, int) - Constructor for class org.apache.lucene.search.uhighlight.UnifiedHighlighter.LimitedStoredFieldVisitor
loadFieldValues(String[], DocIdSetIterator, int) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Loads the String values for each docId by field to be highlighted.

## M

makeFragment(StringBuilder, int[], Field[], FieldFragList.WeightedFragInfo, String[], String[], Encoder) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
MARGIN_DEFAULT - Static variable in class org.apache.lucene.search.vectorhighlight.BaseFragListBuilder
markers - Variable in class org.apache.lucene.search.matchhighlight.Passage
match(char[], int, int) - Method in interface org.apache.lucene.search.uhighlight.CharArrayMatcher
  Return `true` if the passed-in character array matches
match(CharsRef) - Method in interface org.apache.lucene.search.uhighlight.CharArrayMatcher
  Return `true` if the passed-in CharsRef matches
MatchHighlighter - Class in org.apache.lucene.search.matchhighlight
  An example highlighter that combines several lower-level utility classes in this package into a fully featured, ready-to-use component.
MatchHighlighter(IndexSearcher, Analyzer) - Constructor for class org.apache.lucene.search.matchhighlight.MatchHighlighter
MatchHighlighter(IndexSearcher, Analyzer, OffsetsRetrievalStrategySupplier) - Constructor for class org.apache.lucene.search.matchhighlight.MatchHighlighter
MatchHighlighter.DocHighlights - Class in org.apache.lucene.search.matchhighlight
  Single document's highlights.
MatchHighlighter.FieldValueHighlighter - Interface in org.apache.lucene.search.matchhighlight
  Actual per-field highlighter.
MatchHighlighter.QueryOffsetRange - Class in org.apache.lucene.search.matchhighlight
  An `OffsetRange` of a match, together with the source query that caused it.
MatchRegionRetriever - Class in org.apache.lucene.search.matchhighlight
  Utility class to compute a list of "match regions" for a given query, searcher and document(s) using `Matches` API.
MatchRegionRetriever(IndexSearcher, Query, Analyzer, Predicate<String>, Predicate<String>) - Constructor for class org.apache.lucene.search.matchhighlight.MatchRegionRetriever
  This constructor uses the default offset strategy supplier from `MatchRegionRetriever.computeOffsetRetrievalStrategies(IndexReader, Analyzer)`.
MatchRegionRetriever(IndexSearcher, Query, OffsetsRetrievalStrategySupplier, Predicate<String>, Predicate<String>) - Constructor for class org.apache.lucene.search.matchhighlight.MatchRegionRetriever
MatchRegionRetriever.FieldValueProvider - Interface in org.apache.lucene.search.matchhighlight
  Access to field values of the highlighted document.
MatchRegionRetriever.MatchOffsetsConsumer - Interface in org.apache.lucene.search.matchhighlight
  A callback invoked for each document selected by the query.
maxDoc() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
maxLeadingCharacters(int, String, Set<String>) - Static method in class org.apache.lucene.search.matchhighlight.FieldValueHighlighters
  Displays up to `maxLeadingCharacters` of the field's value, regardless of whether it contained highlights or not.
maxLength - Variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.LimitedStoredFieldVisitor
maxNoHighlightPassages - Variable in class org.apache.lucene.search.uhighlight.FieldHighlighter
maxPassages - Variable in class org.apache.lucene.search.uhighlight.FieldHighlighter
maxScan - Variable in class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
MemoryIndexOffsetStrategy - Class in org.apache.lucene.search.uhighlight
  Uses an `Analyzer` on content to get offsets and then populates a `MemoryIndex`.
MemoryIndexOffsetStrategy(UHComponents, Analyzer) - Constructor for class org.apache.lucene.search.uhighlight.MemoryIndexOffsetStrategy
merge(TextFragment) - Method in class org.apache.lucene.search.highlight.TextFragment
MIN_FRAG_CHAR_SIZE_FACTOR - Static variable in class org.apache.lucene.search.vectorhighlight.BaseFragListBuilder
MULTI_TERM_QUERY - Enum constant in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag
MultiFieldsOffsetStrategy - Class in org.apache.lucene.search.uhighlight
  FieldOffsetStrategy that combines offsets from multiple fields.
MultiFieldsOffsetStrategy(List<FieldOffsetStrategy>) - Constructor for class org.apache.lucene.search.uhighlight.MultiFieldsOffsetStrategy
MultiOffsetsEnum(List<OffsetsEnum>) - Constructor for class org.apache.lucene.search.uhighlight.OffsetsEnum.MultiOffsetsEnum
MULTIVAL_SEP_CHAR - Static variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
mustRewriteQuery(SpanQuery) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor

## N

needsField(FieldInfo) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.LimitedStoredFieldVisitor
New features 06/02/2005 - Search tag in package org.apache.lucene.search.highlight
  Section
New features 22/12/2004 - Search tag in package org.apache.lucene.search.highlight
  Section
newFieldHighlighter(String, FieldOffsetStrategy, BreakIterator, PassageScorer, int, int, PassageFormatter, Comparator<Passage>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
newLimitedStoredFieldsVisitor(String[]) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
newTermExtractor(String) - Method in class org.apache.lucene.search.highlight.QueryScorer
next() - Method in class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator
next() - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
next() - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
next() - Method in class org.apache.lucene.search.uhighlight.WholeBreakIterator
next(int) - Method in class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator
next(int) - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
next(int) - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
next(int) - Method in class org.apache.lucene.search.uhighlight.WholeBreakIterator
nextPosition() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.MultiOffsetsEnum
nextPosition() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum
  Advances to the next position and returns true, or if can't then returns false.
nextPosition() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIterator
nextPosition() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIteratorWithSubs
nextPosition() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfPostings
NONE - Static variable in class org.apache.lucene.search.uhighlight.PhraseHelper
NONE_NEEDED - Enum constant in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.OffsetSource
NoOpOffsetStrategy - Class in org.apache.lucene.search.uhighlight
  Never returns offsets.
norm(int) - Method in class org.apache.lucene.search.uhighlight.PassageScorer
  Normalize a passage according to its position in the document.
NullFragmenter - Class in org.apache.lucene.search.highlight
  `Fragmenter` implementation which does not fragment the text.
NullFragmenter() - Constructor for class org.apache.lucene.search.highlight.NullFragmenter
numDocs() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader

## O

OffsetLimitTokenFilter - Class in org.apache.lucene.search.highlight
  This TokenFilter limits the number of tokens while indexing by adding up the current offset.
OffsetLimitTokenFilter(TokenStream, int) - Constructor for class org.apache.lucene.search.highlight.OffsetLimitTokenFilter
OffsetRange - Class in org.apache.lucene.search.matchhighlight
  A non-empty range of offset positions.
OffsetRange(int, int) - Constructor for class org.apache.lucene.search.matchhighlight.OffsetRange
OffsetsEnum - Class in org.apache.lucene.search.uhighlight
  An enumeration/iterator of a term and its offsets for use by `FieldHighlighter`.
OffsetsEnum() - Constructor for class org.apache.lucene.search.uhighlight.OffsetsEnum
OffsetsEnum.MultiOffsetsEnum - Class in org.apache.lucene.search.uhighlight
  A view over several OffsetsEnum instances, merging them in-place
OffsetsEnum.OfMatchesIterator - Class in org.apache.lucene.search.uhighlight
  Based on a `MatchesIterator`; does not look at submatches.
OffsetsEnum.OfMatchesIteratorWithSubs - Class in org.apache.lucene.search.uhighlight
  Based on a `MatchesIterator` with submatches.
OffsetsEnum.OfPostings - Class in org.apache.lucene.search.uhighlight
  Based on a `PostingsEnum` -- the typical/standard OE impl.
OffsetsFromMatchIterator - Class in org.apache.lucene.search.matchhighlight
  This strategy retrieves offsets directly from `MatchesIterator`, if they are available, otherwise it falls back to using `OffsetsFromPositions`.
OffsetsFromMatchIterator(String, OffsetsFromPositions) - Constructor for class org.apache.lucene.search.matchhighlight.OffsetsFromMatchIterator
OffsetsFromPositions - Class in org.apache.lucene.search.matchhighlight
  This strategy applies to fields with stored positions but no offsets.
OffsetsFromPositions(String, Analyzer) - Constructor for class org.apache.lucene.search.matchhighlight.OffsetsFromPositions
OffsetsFromTokens - Class in org.apache.lucene.search.matchhighlight
  This strategy works for fields where we know the match occurred but there are no known positions or offsets.
OffsetsFromTokens(String, Analyzer) - Constructor for class org.apache.lucene.search.matchhighlight.OffsetsFromTokens
OffsetsFromValues - Class in org.apache.lucene.search.matchhighlight
  This strategy works for fields where we know the match occurred but there are no known positions or offsets.
OffsetsFromValues(String, Analyzer) - Constructor for class org.apache.lucene.search.matchhighlight.OffsetsFromValues
OffsetsRetrievalStrategy - Interface in org.apache.lucene.search.matchhighlight
  Determines how match offset regions are computed from `MatchesIterator`.
OffsetsRetrievalStrategySupplier - Interface in org.apache.lucene.search.matchhighlight
  A per-field supplier of `OffsetsRetrievalStrategy`.
OfMatchesIterator(MatchesIterator, Supplier<BytesRef>) - Constructor for class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIterator
OfMatchesIteratorWithSubs(MatchesIterator) - Constructor for class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIteratorWithSubs
OfPostings(BytesRef, int, PostingsEnum) - Constructor for class org.apache.lucene.search.uhighlight.OffsetsEnum.OfPostings
OfPostings(BytesRef, PostingsEnum) - Constructor for class org.apache.lucene.search.uhighlight.OffsetsEnum.OfPostings
or(MatchHighlighter.FieldValueHighlighter) - Method in interface org.apache.lucene.search.matchhighlight.MatchHighlighter.FieldValueHighlighter
  Returns a new field value highlighter that is a combination of this one and another one.
org.apache.lucene.search.highlight - package org.apache.lucene.search.highlight
  Highlighting search terms.
org.apache.lucene.search.matchhighlight - package org.apache.lucene.search.matchhighlight
  This package contains several components useful to build a highlighter on top of the `Matches` API.
org.apache.lucene.search.uhighlight - package org.apache.lucene.search.uhighlight
  The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term vectors, or analysis.
org.apache.lucene.search.vectorhighlight - package org.apache.lucene.search.vectorhighlight
  Another highlighter implementation based on term vectors.
OverlaySingleDocTermsLeafReader - Class in org.apache.lucene.search.uhighlight
  Overlays a 2nd LeafReader for the terms of one field, otherwise the primary reader is consulted.
OverlaySingleDocTermsLeafReader(LeafReader, LeafReader, String, int) - Constructor for class org.apache.lucene.search.uhighlight.OverlaySingleDocTermsLeafReader

## P

Passage - Class in org.apache.lucene.search.matchhighlight
  A passage is a fragment of source text, scored and possibly with a list of sub-offsets (markers) to be highlighted.
Passage - Class in org.apache.lucene.search.uhighlight
  Represents a passage (typically a sentence of the document).
Passage() - Constructor for class org.apache.lucene.search.uhighlight.Passage
Passage(int, int, List<OffsetRange>) - Constructor for class org.apache.lucene.search.matchhighlight.Passage
PASSAGE_RELEVANCY_OVER_SPEED - Enum constant in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag
PassageAdjuster - Interface in org.apache.lucene.search.matchhighlight
  Adjusts the range of one or more passages over a given value.
passageFormatter - Variable in class org.apache.lucene.search.uhighlight.FieldHighlighter
PassageFormatter - Class in org.apache.lucene.search.matchhighlight
  Formats a collection of passages over a given string, cleaning up and resolving restrictions concerning overlaps, allowed sub-ranges over the input string and length restrictions.
PassageFormatter - Class in org.apache.lucene.search.uhighlight
  Creates a formatted snippet from the top passages.
PassageFormatter() - Constructor for class org.apache.lucene.search.uhighlight.PassageFormatter
PassageFormatter(String, String, String) - Constructor for class org.apache.lucene.search.matchhighlight.PassageFormatter
PassageFormatter(String, Function<OffsetRange, String>, Function<OffsetRange, String>) - Constructor for class org.apache.lucene.search.matchhighlight.PassageFormatter
passageScorer - Variable in class org.apache.lucene.search.uhighlight.FieldHighlighter
PassageScorer - Class in org.apache.lucene.search.uhighlight
  Ranks passages found by `UnifiedHighlighter`.
PassageScorer() - Constructor for class org.apache.lucene.search.uhighlight.PassageScorer
  Creates PassageScorer with these default values: `k1 = 1.2`, `b = 0.75`.
PassageScorer(float, float, float) - Constructor for class org.apache.lucene.search.uhighlight.PassageScorer
  Creates PassageScorer with specified scoring parameters
PassageSelector - Class in org.apache.lucene.search.matchhighlight
  Selects fragments of text that score best for the given set of highlight markers.
PassageSelector() - Constructor for class org.apache.lucene.search.matchhighlight.PassageSelector
PassageSelector(Comparator<Passage>, PassageAdjuster) - Constructor for class org.apache.lucene.search.matchhighlight.PassageSelector
passageSortComparator - Variable in class org.apache.lucene.search.uhighlight.FieldHighlighter
phraseHelper() - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Returns the value of the `phraseHelper` record component.
PhraseHelper - Class in org.apache.lucene.search.uhighlight
  Helps the `FieldOffsetStrategy` with position sensitive queries (e.g.
PhraseHelper(Query, String, Predicate<String>, Function<SpanQuery, Boolean>, Function<Query, Collection<Query>>, boolean) - Constructor for class org.apache.lucene.search.uhighlight.PhraseHelper
  Constructor.
phraseHighlight - Variable in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
PHRASES - Enum constant in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag
pickBest(CharSequence, List<? extends OffsetRange>, int, int) - Method in class org.apache.lucene.search.matchhighlight.PassageSelector
pickBest(CharSequence, List<? extends OffsetRange>, int, int, List<OffsetRange>) - Method in class org.apache.lucene.search.matchhighlight.PassageSelector
pickDefaultPassage(CharSequence, int, int, List<OffsetRange>) - Method in class org.apache.lucene.search.matchhighlight.PassageSelector
  Invoked when no passages could be selected (due to constraints or lack of highlight markers).
pop() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack
PositionCheckingMap() - Constructor for class org.apache.lucene.search.highlight.WeightedSpanTermExtractor.PositionCheckingMap
PositionSpan - Class in org.apache.lucene.search.highlight
  Utility class to record Positions Spans
PositionSpan(int, int) - Constructor for class org.apache.lucene.search.highlight.PositionSpan
POSTINGS - Enum constant in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.OffsetSource
POSTINGS_WITH_TERM_VECTORS - Enum constant in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.OffsetSource
PostingsOffsetStrategy - Class in org.apache.lucene.search.uhighlight
  Uses offsets in postings -- `IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS`.
PostingsOffsetStrategy(UHComponents) - Constructor for class org.apache.lucene.search.uhighlight.PostingsOffsetStrategy
PostingsWithTermVectorsOffsetStrategy - Class in org.apache.lucene.search.uhighlight
  Like `PostingsOffsetStrategy` but also uses term vectors (only terms needed) for multi-term queries.
PostingsWithTermVectorsOffsetStrategy(UHComponents) - Constructor for class org.apache.lucene.search.uhighlight.PostingsWithTermVectorsOffsetStrategy
postTag - Variable in class org.apache.lucene.search.uhighlight.DefaultPassageFormatter
  text that will appear after highlighted terms
postTags - Variable in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
preceding(int) - Method in class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator
preceding(int) - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
preceding(int) - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
preceding(int) - Method in class org.apache.lucene.search.uhighlight.WholeBreakIterator
preSpanQueryRewrite(Query) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  When highlighting phrases accurately, we may need to handle custom queries that aren't supported in the `WeightedSpanTermExtractor` as called by the `PhraseHelper`.
preTag - Variable in class org.apache.lucene.search.uhighlight.DefaultPassageFormatter
  text that will appear before highlighted terms
preTags - Variable in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
previous() - Method in class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator
previous() - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
previous() - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
previous() - Method in class org.apache.lucene.search.uhighlight.WholeBreakIterator
push(FieldTermStack.TermInfo) - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack
put(K, WeightedSpanTerm) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor.PositionCheckingMap
putAll(Map<? extends K, ? extends WeightedSpanTerm>) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor.PositionCheckingMap

## Q

query - Variable in class org.apache.lucene.search.matchhighlight.MatchHighlighter.QueryOffsetRange
query() - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Returns the value of the `query` record component.
QueryOffsetRange(Query, int, int) - Constructor for class org.apache.lucene.search.matchhighlight.MatchHighlighter.QueryOffsetRange
QueryPhraseMap(FieldQuery) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap
QueryScorer - Class in org.apache.lucene.search.highlight
  `Scorer` implementation which scores text fragments by the number of unique query terms found.
QueryScorer(WeightedSpanTerm[]) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryScorer(Query) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryScorer(Query, String) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryScorer(Query, String, String) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryScorer(Query, IndexReader, String) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryScorer(Query, IndexReader, String, String) - Constructor for class org.apache.lucene.search.highlight.QueryScorer
QueryTermExtractor - Class in org.apache.lucene.search.highlight
  Utility class used to extract the terms used in a query, plus any weights.
QueryTermExtractor() - Constructor for class org.apache.lucene.search.highlight.QueryTermExtractor
QueryTermScorer - Class in org.apache.lucene.search.highlight
  `Scorer` implementation which scores text fragments by the number of unique query terms found.
QueryTermScorer(WeightedTerm[]) - Constructor for class org.apache.lucene.search.highlight.QueryTermScorer
QueryTermScorer(Query) - Constructor for class org.apache.lucene.search.highlight.QueryTermScorer
QueryTermScorer(Query, String) - Constructor for class org.apache.lucene.search.highlight.QueryTermScorer
QueryTermScorer(Query, IndexReader, String) - Constructor for class org.apache.lucene.search.highlight.QueryTermScorer

## R

requiresRewrite(SpanQuery) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  When highlighting phrases accurately, we need to know which `SpanQuery`'s need to have `Query.rewrite(IndexSearcher)` called on them.
reset() - Method in class org.apache.lucene.search.highlight.OffsetLimitTokenFilter
reset() - Method in class org.apache.lucene.search.highlight.TokenStreamFromTermVector
reset() - Method in class org.apache.lucene.search.uhighlight.Passage

## S

score(Passage, int) - Method in class org.apache.lucene.search.uhighlight.PassageScorer
ScoreComparator() - Constructor for class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder.ScoreComparator
ScoreOrderFragmentsBuilder - Class in org.apache.lucene.search.vectorhighlight
  An implementation of FragmentsBuilder that outputs score-order fragments.
ScoreOrderFragmentsBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder
  a constructor.
ScoreOrderFragmentsBuilder(String[], String[]) - Constructor for class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder
  a constructor.
ScoreOrderFragmentsBuilder(String[], String[], BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder
ScoreOrderFragmentsBuilder(BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.ScoreOrderFragmentsBuilder
ScoreOrderFragmentsBuilder.ScoreComparator - Class in org.apache.lucene.search.vectorhighlight
  Comparator for `FieldFragList.WeightedFragInfo` by boost, breaking ties by offset.
Scorer - Interface in org.apache.lucene.search.highlight
  A Scorer is responsible for scoring a stream of tokens.
searcher - Variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
searchNearestVectors(String, byte[], KnnCollector, AcceptDocs) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
searchNearestVectors(String, float[], KnnCollector, AcceptDocs) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
searchPhrase(String, List<FieldTermStack.TermInfo>) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery
searchPhrase(List<FieldTermStack.TermInfo>) - Method in class org.apache.lucene.search.vectorhighlight.FieldQuery.QueryPhraseMap
seqnum() - Method in record class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo
  Returns the value of the `seqnum` record component.
setBreakIterator(Supplier<BreakIterator>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setCacheFieldValCharsThreshold(int) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setDiscreteMultiValueHighlighting(boolean) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
setEncoder(Encoder) - Method in class org.apache.lucene.search.highlight.Highlighter
setEndOffset(int) - Method in class org.apache.lucene.search.uhighlight.Passage
setEndOffset(int) - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs
setExpandMultiTermQuery(boolean) - Method in class org.apache.lucene.search.highlight.QueryScorer
  Controls whether or not multi-term queries are expanded against a `MemoryIndex` `IndexReader`.
setExpandMultiTermQuery(boolean) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
setFieldMatcher(Predicate<String>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setFormatter(PassageFormatter) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setFragmentScorer(Scorer) - Method in class org.apache.lucene.search.highlight.Highlighter
setFragmentSize(int) - Method in class org.apache.lucene.search.highlight.SimpleFragmenter
setHandleMultiTermQuery(boolean) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setHighlightPhrasesStrictly(boolean) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setMaxDocCharsToAnalyze(int) - Method in class org.apache.lucene.search.highlight.Highlighter
setMaxDocCharsToAnalyze(int) - Method in class org.apache.lucene.search.highlight.QueryScorer
setMaxDocCharsToAnalyze(int) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  A threshold of number of characters to analyze.
setMaxLength(int) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setMaxNoHighlightPassages(int) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setMultiValuedSeparator(char) - Method in class org.apache.lucene.search.vectorhighlight.BaseFragmentsBuilder
setPassageRelevancyOverSpeed(boolean) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setPhraseLimit(int) - Method in class org.apache.lucene.search.vectorhighlight.FastVectorHighlighter
  set the maximum number of phrases to analyze when searching for the highest-scoring phrase.
setPositionSensitive(boolean) - Method in class org.apache.lucene.search.highlight.WeightedSpanTerm
setScore(float) - Method in class org.apache.lucene.search.uhighlight.Passage
setScorer(PassageScorer) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setStartOffset(int) - Method in class org.apache.lucene.search.uhighlight.Passage
setTerm(String) - Method in class org.apache.lucene.search.highlight.WeightedTerm
setText(String) - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
setText(String) - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
setText(CharacterIterator) - Method in class org.apache.lucene.search.uhighlight.CustomSeparatorBreakIterator
setText(CharacterIterator) - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
setText(CharacterIterator) - Method in class org.apache.lucene.search.uhighlight.SplittingBreakIterator
setText(CharacterIterator) - Method in class org.apache.lucene.search.uhighlight.WholeBreakIterator
setTextFragmenter(Fragmenter) - Method in class org.apache.lucene.search.highlight.Highlighter
setUsePayloads(boolean) - Method in class org.apache.lucene.search.highlight.QueryScorer
setUsePayloads(boolean) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
setWeight(float) - Method in class org.apache.lucene.search.highlight.WeightedTerm
setWeightMatches(boolean) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
setWrapIfNotCachingTokenFilter(boolean) - Method in class org.apache.lucene.search.highlight.QueryScorer
  By default, `TokenStream`s that are not of the type `CachingTokenFilter` are wrapped in a `CachingTokenFilter` to ensure an efficient reset - if you are already using a different caching `TokenStream` impl and you don't want it to be wrapped, set this to false.
setWrapIfNotCachingTokenFilter(boolean) - Method in class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
  By default, `TokenStream`s that are not of the type `CachingTokenFilter` are wrapped in a `CachingTokenFilter` to ensure an efficient reset - if you are already using a different caching `TokenStream` impl and you don't want it to be wrapped, set this to false.
shouldHandleMultiTermQuery(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
shouldHighlightPhrasesStrictly(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
shouldPreferPassageRelevancyOverSpeed(String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
SimpleBoundaryScanner - Class in org.apache.lucene.search.vectorhighlight
  Simple boundary scanner implementation that divides fragments based on a set of separator characters.
SimpleBoundaryScanner() - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
SimpleBoundaryScanner(int) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
SimpleBoundaryScanner(int, char[]) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
SimpleBoundaryScanner(int, Character[]) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
SimpleBoundaryScanner(int, Set<Character>) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
SimpleBoundaryScanner(Character[]) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleBoundaryScanner
SimpleFieldFragList - Class in org.apache.lucene.search.vectorhighlight
  A simple implementation of `FieldFragList`.
SimpleFieldFragList(int) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFieldFragList
  a constructor.
SimpleFragListBuilder - Class in org.apache.lucene.search.vectorhighlight
  A simple implementation of `FragListBuilder`.
SimpleFragListBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragListBuilder
SimpleFragListBuilder(int) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragListBuilder
SimpleFragmenter - Class in org.apache.lucene.search.highlight
  `Fragmenter` implementation which breaks text up into same-size fragments with no concerns over spotting sentence boundaries.
SimpleFragmenter() - Constructor for class org.apache.lucene.search.highlight.SimpleFragmenter
SimpleFragmenter(int) - Constructor for class org.apache.lucene.search.highlight.SimpleFragmenter
SimpleFragmentsBuilder - Class in org.apache.lucene.search.vectorhighlight
  A simple implementation of FragmentsBuilder.
SimpleFragmentsBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragmentsBuilder
  a constructor.
SimpleFragmentsBuilder(String[], String[]) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragmentsBuilder
  a constructor.
SimpleFragmentsBuilder(String[], String[], BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragmentsBuilder
SimpleFragmentsBuilder(BoundaryScanner) - Constructor for class org.apache.lucene.search.vectorhighlight.SimpleFragmentsBuilder
SimpleHTMLEncoder - Class in org.apache.lucene.search.highlight
  Simple `Encoder` implementation to escape text for HTML output
SimpleHTMLEncoder() - Constructor for class org.apache.lucene.search.highlight.SimpleHTMLEncoder
SimpleHTMLFormatter - Class in org.apache.lucene.search.highlight
  Simple `Formatter` implementation to highlight terms with a pre and post tag.
SimpleHTMLFormatter() - Constructor for class org.apache.lucene.search.highlight.SimpleHTMLFormatter
  Default constructor uses HTML: <B> tags to markup terms.
SimpleHTMLFormatter(String, String) - Constructor for class org.apache.lucene.search.highlight.SimpleHTMLFormatter
SimpleSpanFragmenter - Class in org.apache.lucene.search.highlight
  `Fragmenter` implementation which breaks text up into same-size fragments but does not split up `Spans`.
SimpleSpanFragmenter(QueryScorer) - Constructor for class org.apache.lucene.search.highlight.SimpleSpanFragmenter
SimpleSpanFragmenter(QueryScorer, int) - Constructor for class org.apache.lucene.search.highlight.SimpleSpanFragmenter
SingleFragListBuilder - Class in org.apache.lucene.search.vectorhighlight
  An implementation class of `FragListBuilder` that generates one `FieldFragList.WeightedFragInfo` object.
SingleFragListBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.SingleFragListBuilder
skipRemaining() - Static method in class org.apache.lucene.search.matchhighlight.FieldValueHighlighters
  Matches all fields and omits their value in the output (so that no highlight or value is emitted).
slice(int, int) - Method in class org.apache.lucene.search.matchhighlight.MatchHighlighter.QueryOffsetRange
slice(int, int) - Method in class org.apache.lucene.search.matchhighlight.OffsetRange
  Returns a sub-range of this range (a copy).
slice(int, int) - Method in class org.apache.lucene.search.matchhighlight.Passage
  Passages can't be sliced as it could split previously determined highlight markers.
SpanGradientFormatter - Class in org.apache.lucene.search.highlight
  Formats text with different color intensity depending on the score of the term using the span tag.
SpanGradientFormatter(float, String, String, String, String) - Constructor for class org.apache.lucene.search.highlight.SpanGradientFormatter
SplittingBreakIterator - Class in org.apache.lucene.search.uhighlight
  Virtually slices the text on both sides of every occurrence of the specified character.
SplittingBreakIterator(BreakIterator, char) - Constructor for class org.apache.lucene.search.uhighlight.SplittingBreakIterator
start(String, TokenStream) - Method in interface org.apache.lucene.search.highlight.Fragmenter
  Initializes the Fragmenter.
start(String, TokenStream) - Method in class org.apache.lucene.search.highlight.NullFragmenter
start(String, TokenStream) - Method in class org.apache.lucene.search.highlight.SimpleFragmenter
start(String, TokenStream) - Method in class org.apache.lucene.search.highlight.SimpleSpanFragmenter
startFragment(TextFragment) - Method in class org.apache.lucene.search.highlight.QueryScorer
startFragment(TextFragment) - Method in class org.apache.lucene.search.highlight.QueryTermScorer
startFragment(TextFragment) - Method in interface org.apache.lucene.search.highlight.Scorer
  Called when a new fragment is started for consideration.
startOffset() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.MultiOffsetsEnum
startOffset() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIterator
startOffset() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfMatchesIteratorWithSubs
startOffset() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum.OfPostings
startOffset() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum
Step 1. - Search tag in package org.apache.lucene.search.vectorhighlight
  Section
Step 2. - Search tag in package org.apache.lucene.search.vectorhighlight
  Section
Step 3. - Search tag in package org.apache.lucene.search.vectorhighlight
  Section
Step 4. - Search tag in package org.apache.lucene.search.vectorhighlight
  Section
Step 5. - Search tag in package org.apache.lucene.search.vectorhighlight
  Section
storedFields() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
stringField(FieldInfo, String) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.LimitedStoredFieldVisitor
SubInfo(String, List<FieldPhraseList.WeightedPhraseInfo.Toffs>, int, float) - Constructor for record class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo
  Creates an instance of a `SubInfo` record class.

## T

TERM_VECTORS - Enum constant in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.OffsetSource
terms() - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Returns the value of the `terms` record component.
terms(String) - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
terms(String) - Method in class org.apache.lucene.search.uhighlight.OverlaySingleDocTermsLeafReader
termsOffsets() - Method in record class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo
  Returns the value of the `termsOffsets` record component.
TermVectorLeafReader - Class in org.apache.lucene.search.highlight
  Wraps a Terms with a `LeafReader`, typically from term vectors.
TermVectorLeafReader(String, Terms) - Constructor for class org.apache.lucene.search.highlight.TermVectorLeafReader
TermVectorOffsetStrategy - Class in org.apache.lucene.search.uhighlight
  Uses term vectors that contain offsets.
TermVectorOffsetStrategy(UHComponents) - Constructor for class org.apache.lucene.search.uhighlight.TermVectorOffsetStrategy
termVectors() - Method in class org.apache.lucene.search.highlight.TermVectorLeafReader
text() - Method in record class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo
  Returns the value of the `text` record component.
TextFragment - Class in org.apache.lucene.search.highlight
  Low-level class used to record information about a section of a document with a score.
TextFragment(CharSequence, int, int) - Constructor for class org.apache.lucene.search.highlight.TextFragment
tf(int, int) - Method in class org.apache.lucene.search.uhighlight.PassageScorer
  Computes term weight, given the frequency within the passage and the passage's length.
to - Variable in class org.apache.lucene.search.matchhighlight.OffsetRange
  End index, exclusive.
Toffs(int, int) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs
TokenGroup - Class in org.apache.lucene.search.highlight
  One, or several overlapping tokens, along with the score(s) and the scope of the original text.
TokenGroup(TokenStream) - Constructor for class org.apache.lucene.search.highlight.TokenGroup
TokenSources - Class in org.apache.lucene.search.highlight
  Convenience methods for obtaining a `TokenStream` for use with the `Highlighter` - can obtain from term vectors with offsets and positions or from an Analyzer re-parsing the stored content.
tokenStream(String) - Method in class org.apache.lucene.search.uhighlight.AnalysisOffsetStrategy
TokenStreamFromTermVector - Class in org.apache.lucene.search.highlight
  TokenStream created from a term vector field.
TokenStreamFromTermVector(Terms, int) - Constructor for class org.apache.lucene.search.highlight.TokenStreamFromTermVector
  Constructor.
TokenStreamOffsetStrategy - Class in org.apache.lucene.search.uhighlight
  Analyzes the text, producing a single `OffsetsEnum` wrapping the `TokenStream` filtered to terms in the query, including wildcards.
TokenStreamOffsetStrategy(UHComponents, Analyzer) - Constructor for class org.apache.lucene.search.uhighlight.TokenStreamOffsetStrategy
toString() - Method in class org.apache.lucene.search.highlight.TextFragment
toString() - Method in class org.apache.lucene.search.matchhighlight.OffsetRange
toString() - Method in class org.apache.lucene.search.matchhighlight.Passage
toString() - Method in class org.apache.lucene.search.uhighlight.LengthGoalBreakIterator
toString() - Method in class org.apache.lucene.search.uhighlight.OffsetsEnum
toString() - Method in class org.apache.lucene.search.uhighlight.Passage
  For debugging.
toString() - Method in record class org.apache.lucene.search.uhighlight.UHComponents
  Returns a string representation of this record class.
toString() - Method in record class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo.SubInfo
  Returns a string representation of this record class.
toString() - Method in class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo
toString() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo.Toffs
toString() - Method in class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
toString() - Method in class org.apache.lucene.search.vectorhighlight.FieldTermStack.TermInfo

## U

UHComponents - Record Class in org.apache.lucene.search.uhighlight
  A parameter object to hold the components a `FieldOffsetStrategy` needs.
UHComponents(String, Predicate<String>, Query, BytesRef[], PhraseHelper, LabelledCharArrayMatcher[], boolean, Set<UnifiedHighlighter.HighlightFlag>) - Constructor for record class org.apache.lucene.search.uhighlight.UHComponents
  Creates an instance of a `UHComponents` record class.
UnifiedHighlighter - Class in org.apache.lucene.search.uhighlight
  A Highlighter that can get offsets from either postings (`IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS`), term vectors (`FieldType.setStoreTermVectorOffsets(boolean)`), or via re-analyzing text.
UnifiedHighlighter(IndexSearcher, Analyzer) - Constructor for class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Deprecated.
UnifiedHighlighter(UnifiedHighlighter.Builder) - Constructor for class org.apache.lucene.search.uhighlight.UnifiedHighlighter
  Constructs the highlighter with the given `UnifiedHighlighter.Builder`.
UnifiedHighlighter.Builder - Class in org.apache.lucene.search.uhighlight
  Builder for UnifiedHighlighter.
UnifiedHighlighter.HighlightFlag - Enum Class in org.apache.lucene.search.uhighlight
  Flags for controlling highlighting behavior.
UnifiedHighlighter.LimitedStoredFieldVisitor - Class in org.apache.lucene.search.uhighlight
  Fetches stored fields for highlighting.
UnifiedHighlighter.OffsetSource - Enum Class in org.apache.lucene.search.uhighlight
  Source of term offsets; essential for highlighting.

## V

valueOf(String) - Static method in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag
  Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.OffsetSource
  Returns the enum constant of this class with the specified name.
values - Variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.LimitedStoredFieldVisitor
values() - Static method in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag
  Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.OffsetSource
  Returns an array containing the constants of this enum class, in the order they are declared.
valueSeparator - Variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.LimitedStoredFieldVisitor
verbatimValue(String, String...) - Static method in class org.apache.lucene.search.matchhighlight.FieldValueHighlighters
  Always returns raw field values, no highlighting or value truncation is applied.

## W

weight(int, int) - Method in class org.apache.lucene.search.uhighlight.PassageScorer
  Computes term importance, given its in-document statistics.
WEIGHT_MATCHES - Enum constant in enum class org.apache.lucene.search.uhighlight.UnifiedHighlighter.HighlightFlag
WeightedFieldFragList - Class in org.apache.lucene.search.vectorhighlight
  A weighted implementation of `FieldFragList`.
WeightedFieldFragList(int) - Constructor for class org.apache.lucene.search.vectorhighlight.WeightedFieldFragList
  a constructor.
WeightedFragInfo(int, int, List<FieldFragList.WeightedFragInfo.SubInfo>, float) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldFragList.WeightedFragInfo
WeightedFragListBuilder - Class in org.apache.lucene.search.vectorhighlight
  A weighted implementation of `FragListBuilder`.
WeightedFragListBuilder() - Constructor for class org.apache.lucene.search.vectorhighlight.WeightedFragListBuilder
WeightedFragListBuilder(int) - Constructor for class org.apache.lucene.search.vectorhighlight.WeightedFragListBuilder
WeightedPhraseInfo(Collection<FieldPhraseList.WeightedPhraseInfo>) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
  Merging constructor.
WeightedPhraseInfo(LinkedList<FieldTermStack.TermInfo>, float) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
WeightedPhraseInfo(LinkedList<FieldTermStack.TermInfo>, float, int) - Constructor for class org.apache.lucene.search.vectorhighlight.FieldPhraseList.WeightedPhraseInfo
WeightedSpanTerm - Class in org.apache.lucene.search.highlight
  Lightweight class to hold term, weight, and positions used for scoring this term.
WeightedSpanTerm(float, String) - Constructor for class org.apache.lucene.search.highlight.WeightedSpanTerm
WeightedSpanTerm(float, String, boolean) - Constructor for class org.apache.lucene.search.highlight.WeightedSpanTerm
WeightedSpanTermExtractor - Class in org.apache.lucene.search.highlight
  Class used to extract `WeightedSpanTerm`s from a `Query` based on whether `Term`s from the `Query` are contained in a supplied `TokenStream`.
WeightedSpanTermExtractor() - Constructor for class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
WeightedSpanTermExtractor(String) - Constructor for class org.apache.lucene.search.highlight.WeightedSpanTermExtractor
WeightedSpanTermExtractor.PositionCheckingMap<K> - Class in org.apache.lucene.search.highlight
  This class makes sure that if both position sensitive and insensitive versions of the same term are added, the position insensitive one wins.
WeightedTerm - Class in org.apache.lucene.search.highlight
  Lightweight class to hold term and a weight value used for scoring this term
WeightedTerm(float, String) - Constructor for class org.apache.lucene.search.highlight.WeightedTerm
WholeBreakIterator - Class in org.apache.lucene.search.uhighlight
  Just produces one single fragment for the entire text
WholeBreakIterator() - Constructor for class org.apache.lucene.search.uhighlight.WholeBreakIterator
willRewrite() - Method in class org.apache.lucene.search.uhighlight.PhraseHelper
  Rewrite is needed for handling a `SpanMultiTermQueryWrapper` (MTQ / wildcards) or some custom things.
withBreakIterator(Supplier<BreakIterator>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
withCacheFieldValCharsThreshold(int) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
withFieldMatcher(Predicate<String>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
withFlags(Set<UnifiedHighlighter.HighlightFlag>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
  User-defined set of `UnifiedHighlighter.HighlightFlag` values which will override the flags set by `UnifiedHighlighter.Builder.withHandleMultiTermQuery(boolean)`, `UnifiedHighlighter.Builder.withHighlightPhrasesStrictly(boolean)`, `UnifiedHighlighter.Builder.withPassageRelevancyOverSpeed(boolean)` and `UnifiedHighlighter.Builder.withWeightMatches(boolean)`.
withFormatter(PassageFormatter) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
withHandleMultiTermQuery(boolean) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
  Here `MultiTermQuery` derivatives will be highlighted.
withHighlightPhrasesStrictly(boolean) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
  Here position sensitive queries (e.g.
withMaskedFieldsFunc(Function<String, Set<String>>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
  Set up a function that given a field retuns a set of masked fields whose matches are combined to highlight the given field.
withMaxLength(int) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
  The text to be highlight is effectively truncated by this length.
withMaxNoHighlightPassages(int) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
withPassageRelevancyOverSpeed(boolean) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
  Passage relevancy is more important than speed.
withPassageSortComparator(Comparator<Passage>) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
withScorer(PassageScorer) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
withWeightMatches(boolean) - Method in class org.apache.lucene.search.uhighlight.UnifiedHighlighter.Builder
  Internally use the `Weight.matches(LeafReaderContext, int)` API for highlighting.
wrap(String, CharArrayMatcher) - Static method in interface org.apache.lucene.search.uhighlight.LabelledCharArrayMatcher
  Associates a label with a CharArrayMatcher
wrap(String, ByteRunAutomaton) - Static method in interface org.apache.lucene.search.uhighlight.LabelledCharArrayMatcher
  Returns a representation of the automaton that matches char[] instead of byte[]

## Z

ZERO_LEN_AUTOMATA_ARRAY - Static variable in class org.apache.lucene.search.uhighlight.UnifiedHighlighter

A B C D E F G H I L M N O P Q R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form