Uses of Class
org.apache.lucene.search.matchhighlight.OffsetRange

Packages that use OffsetRange

Package	Description
org.apache.lucene.search.matchhighlight	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.matchhighlight

Modifier and Type	Class	Description
static class	MatchHighlighter.QueryOffsetRange	An OffsetRange of a match, together with the source query that caused it.
class	Passage	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 OffsetRange

Modifier and Type	Field	Description
OffsetRange	PassageFormatter.SlicePoint.marker

Fields in org.apache.lucene.search.matchhighlight with type parameters of type OffsetRange

Modifier and Type	Field	Description
private java.util.function.Function<OffsetRange,java.lang.String>	PassageFormatter.markerEnd
java.util.List<OffsetRange>	Passage.markers
private java.util.ArrayList<OffsetRange>	PassageFormatter.markerStack
private java.util.function.Function<OffsetRange,java.lang.String>	PassageFormatter.markerStart

Methods in org.apache.lucene.search.matchhighlight that return OffsetRange

Modifier and Type	Method	Description
OffsetRange	BreakIteratorShrinkingAdjuster.adjust(Passage passage)
OffsetRange	PassageAdjuster.adjust(Passage p)
OffsetRange	OffsetRange.clone()
OffsetRange	OffsetRange.slice(int from, int to)	Returns a sub-range of this range (a copy).
OffsetRange	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 OffsetRange

Modifier and Type	Method	Description
private java.util.List<OffsetRange>	MatchHighlighter.computeValueRanges(java.lang.String field, java.lang.String[] values)
(package private) java.util.List<OffsetRange>	OffsetsFromPositions.convertPositionsToOffsets(java.util.ArrayList<OffsetRange> positionRanges, java.util.List<java.lang.CharSequence> values)
java.util.List<OffsetRange>	OffsetsFromMatchIterator.get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)
java.util.List<OffsetRange>	OffsetsFromPositions.get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)
java.util.List<OffsetRange>	OffsetsFromTokens.get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)
java.util.List<OffsetRange>	OffsetsFromValues.get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)
java.util.List<OffsetRange>	OffsetsRetrievalStrategy.get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)	Return value offsets (match ranges) acquired from the given MatchesIterator.
private java.util.List<? extends OffsetRange>	PassageSelector.splitOrTruncateToWindows(java.util.List<? extends OffsetRange> markers, int maxPassageWindow, java.util.List<OffsetRange> permittedPassageRanges)	Truncate or split highlight markers that cross permitted value boundaries.

Methods in org.apache.lucene.search.matchhighlight with parameters of type OffsetRange

Modifier and Type	Method	Description
boolean	OffsetRange.contains(OffsetRange other)
private boolean	PassageFormatter.withinRange(OffsetRange limits, java.util.List<? extends OffsetRange> contained)

Method parameters in org.apache.lucene.search.matchhighlight with type arguments of type OffsetRange

Modifier and Type	Method	Description
void	MatchRegionRetriever.MatchOffsetsConsumer.accept(int docId, LeafReader leafReader, int leafDocId, java.util.Map<java.lang.String,java.util.List<OffsetRange>> hits)
(package private) void	MatchHighlighter.DocHit.addMatches(Query query, java.util.Map<java.lang.String,java.util.List<OffsetRange>> hits)
(package private) java.util.List<OffsetRange>	OffsetsFromPositions.convertPositionsToOffsets(java.util.ArrayList<OffsetRange> positionRanges, java.util.List<java.lang.CharSequence> values)
java.util.List<java.lang.String>	MatchHighlighter.FieldValueHighlighter.format(java.lang.String field, java.lang.String[] values, java.lang.String contiguousValue, java.util.List<OffsetRange> valueRanges, java.util.List<MatchHighlighter.QueryOffsetRange> matchOffsets)	Do format field values appropriately.
void	MatchRegionRetriever.highlightDocument(LeafReaderContext leafReaderContext, int contextDocId, MatchRegionRetriever.FieldValueProvider doc, java.util.function.Predicate<java.lang.String> acceptField, java.util.Map<java.lang.String,java.util.List<OffsetRange>> outputHighlights)	Low-level method for retrieving hit ranges for a single document.
private void	PassageFormatter.multipleMarkers(java.lang.CharSequence value, Passage p, java.lang.StringBuilder b, java.util.ArrayList<OffsetRange> markerStack)	Handle multiple markers, possibly overlapping or nested.
java.util.List<Passage>	PassageSelector.pickBest(java.lang.CharSequence value, java.util.List<? extends OffsetRange> markers, int maxPassageWindow, int maxPassages)
java.util.List<Passage>	PassageSelector.pickBest(java.lang.CharSequence value, java.util.List<? extends OffsetRange> markers, int maxPassageWindow, int maxPassages, java.util.List<OffsetRange> permittedPassageRanges)
protected Passage[]	PassageSelector.pickDefaultPassage(java.lang.CharSequence value, int maxCharacterWindow, int maxPassages, java.util.List<OffsetRange> permittedPassageRanges)	Invoked when no passages could be selected (due to constraints or lack of highlight markers).
(package private) static boolean	PassageSelector.sortedAndNonOverlapping(java.util.List<? extends OffsetRange> permittedPassageRanges)
private java.util.List<? extends OffsetRange>	PassageSelector.splitOrTruncateToWindows(java.util.List<? extends OffsetRange> markers, int maxPassageWindow, java.util.List<OffsetRange> permittedPassageRanges)	Truncate or split highlight markers that cross permitted value boundaries.
private boolean	PassageFormatter.withinRange(OffsetRange limits, java.util.List<? extends OffsetRange> contained)

Constructors in org.apache.lucene.search.matchhighlight with parameters of type OffsetRange

Constructor	Description
SlicePoint(PassageFormatter.SlicePoint.Type t, int offset, OffsetRange m)

Constructor parameters in org.apache.lucene.search.matchhighlight with type arguments of type OffsetRange

Constructor	Description
Passage(int from, int to, java.util.List<OffsetRange> markers)
PassageFormatter(java.lang.String ellipsis, java.util.function.Function<OffsetRange,java.lang.String> markerStart, java.util.function.Function<OffsetRange,java.lang.String> markerEnd)