Uses of Package org.apache.lucene.search.uhighlight (Lucene 10.5.1 highlighter API)
Description: use: package: org.apache.lucene.search.uhighlight

# Uses of Package
org.apache.lucene.search.uhighlight

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

- Classes in org.apache.lucene.search.uhighlight used by org.apache.lucene.search.uhighlight
  Class
  Description
  AnalysisOffsetStrategy
  Provides a base class for analysis based offset strategies to extend from.
  CharArrayMatcher
  Matches a character array
  FieldHighlighter
  Internal highlighter abstraction that operates on a per field basis.
  FieldOffsetStrategy
  Ultimately returns an `OffsetsEnum` yielding potentially highlightable words in the text.
  LabelledCharArrayMatcher
  Associates a label with a CharArrayMatcher to distinguish different sources for terms in highlighting
  LengthGoalBreakIterator
  Wraps another `BreakIterator` to skip past breaks that would result in passages that are too short.
  NoOpOffsetStrategy
  Never returns offsets.
  OffsetsEnum
  An enumeration/iterator of a term and its offsets for use by `FieldHighlighter`.
  Passage
  Represents a passage (typically a sentence of the document).
  PassageFormatter
  Creates a formatted snippet from the top passages.
  PassageScorer
  Ranks passages found by `UnifiedHighlighter`.
  PhraseHelper
  Helps the `FieldOffsetStrategy` with position sensitive queries (e.g.
  UHComponents
  A parameter object to hold the components a `FieldOffsetStrategy` needs.
  UnifiedHighlighter
  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.Builder
  Builder for UnifiedHighlighter.
  UnifiedHighlighter.HighlightFlag
  Flags for controlling highlighting behavior.
  UnifiedHighlighter.LimitedStoredFieldVisitor
  Fetches stored fields for highlighting.
  UnifiedHighlighter.OffsetSource
  Source of term offsets; essential for highlighting.