Uses of Class
org.apache.lucene.search.matchhighlight.OffsetRange
Packages that use OffsetRange
Package
Description
This package contains several components useful to build a highlighter on top of the
Matches
API.-
Uses of OffsetRange in org.apache.lucene.search.matchhighlight
Subclasses of OffsetRange in org.apache.lucene.search.matchhighlightModifier and TypeClassDescriptionstatic class
AnOffsetRange
of a match, together with the source query that caused it.class
A passage is a fragment of source text, scored and possibly with a list of sub-offsets (markers) to be highlighted.Fields in org.apache.lucene.search.matchhighlight declared as OffsetRangeFields in org.apache.lucene.search.matchhighlight with type parameters of type OffsetRangeModifier and TypeFieldDescriptionprivate final Map
<String, List<OffsetRange>> MatchRegionRetriever.DocHighlightData.hits
The field for thehits
record component.private final Function
<OffsetRange, String> PassageFormatter.markerEnd
Passage.markers
private final ArrayList
<OffsetRange> PassageFormatter.markerStack
private final Function
<OffsetRange, String> PassageFormatter.markerStart
Methods in org.apache.lucene.search.matchhighlight that return OffsetRangeModifier and TypeMethodDescriptionOffsetRange.clone()
OffsetRange.slice
(int from, int to) Returns a sub-range of this range (a copy).Passage.slice
(int from, int to) Passages can't be sliced as it could split previously determined highlight markers.Methods in org.apache.lucene.search.matchhighlight that return types with arguments of type OffsetRangeModifier and TypeMethodDescriptionprivate List
<OffsetRange> MatchHighlighter.computeValueRanges
(String field, List<String> values) (package private) List
<OffsetRange> OffsetsFromPositions.convertPositionsToOffsets
(ArrayList<OffsetRange> positionRanges, List<String> values) OffsetsFromMatchIterator.get
(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc) OffsetsFromPositions.get
(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc) OffsetsFromTokens.get
(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc) OffsetsFromValues.get
(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc) OffsetsRetrievalStrategy.get
(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc) Return value offsets (match ranges) acquired from the givenMatchesIterator
.MatchRegionRetriever.DocHighlightData.hits()
Returns the value of thehits
record component.private List
<? extends OffsetRange> PassageSelector.splitOrTruncateToWindows
(List<? extends OffsetRange> markers, int maxPassageWindow, List<OffsetRange> permittedPassageRanges) Truncate or split highlight markers that cross permitted value boundaries.Methods in org.apache.lucene.search.matchhighlight with parameters of type OffsetRangeModifier and TypeMethodDescriptionboolean
OffsetRange.contains
(OffsetRange other) private boolean
PassageFormatter.withinRange
(OffsetRange limits, List<? extends OffsetRange> contained) Method parameters in org.apache.lucene.search.matchhighlight with type arguments of type OffsetRangeModifier and TypeMethodDescriptionvoid
MatchRegionRetriever.MatchOffsetsConsumer.accept
(int docId, LeafReader leafReader, int leafDocId, MatchRegionRetriever.FieldValueProvider fieldValueProvider, Map<String, List<OffsetRange>> hits) (package private) void
MatchHighlighter.DocHit.addMatches
(Query query, Map<String, List<OffsetRange>> hits) (package private) List
<OffsetRange> OffsetsFromPositions.convertPositionsToOffsets
(ArrayList<OffsetRange> positionRanges, List<String> values) void
MatchRegionRetriever.highlightDocument
(LeafReaderContext leafReaderContext, int contextDocId, MatchRegionRetriever.FieldValueProvider doc, ToIntFunction<String> maxHitsPerField, Map<String, List<OffsetRange>> outputHighlights) Low-level method for retrieving hit ranges for a single document.private void
PassageFormatter.multipleMarkers
(CharSequence value, Passage p, StringBuilder b, ArrayList<OffsetRange> markerStack) Handle multiple markers, possibly overlapping or nested.PassageSelector.pickBest
(CharSequence value, List<? extends OffsetRange> markers, int maxPassageWindow, int maxPassages) PassageSelector.pickBest
(CharSequence value, List<? extends OffsetRange> markers, int maxPassageWindow, int maxPassages, List<OffsetRange> permittedPassageRanges) protected Passage[]
PassageSelector.pickDefaultPassage
(CharSequence value, int maxCharacterWindow, int maxPassages, List<OffsetRange> permittedPassageRanges) Invoked when no passages could be selected (due to constraints or lack of highlight markers).(package private) static boolean
PassageSelector.sortedAndNonOverlapping
(List<? extends OffsetRange> permittedPassageRanges) private List
<? extends OffsetRange> PassageSelector.splitOrTruncateToWindows
(List<? extends OffsetRange> markers, int maxPassageWindow, List<OffsetRange> permittedPassageRanges) Truncate or split highlight markers that cross permitted value boundaries.private boolean
PassageFormatter.withinRange
(OffsetRange limits, List<? extends OffsetRange> contained) Constructors in org.apache.lucene.search.matchhighlight with parameters of type OffsetRangeModifierConstructorDescriptionSlicePoint
(PassageFormatter.SlicePoint.Type t, int offset, OffsetRange m) Constructor parameters in org.apache.lucene.search.matchhighlight with type arguments of type OffsetRangeModifierConstructorDescriptionprivate
DocHighlightData
(int docId, LeafReader leafReader, int leafDocId, MatchRegionRetriever.FieldValueProvider fieldValueProvider, Map<String, List<OffsetRange>> hits) Creates an instance of aDocHighlightData
record class.Passage
(int from, int to, List<OffsetRange> markers) PassageFormatter
(String ellipsis, Function<OffsetRange, String> markerStart, Function<OffsetRange, String> markerEnd)