Package org.apache.lucene.search.matchhighlight

Class OffsetsFromMatchIterator

java.lang.Object

org.apache.lucene.search.matchhighlight.OffsetsFromMatchIterator

All Implemented Interfaces:

OffsetsRetrievalStrategy

public final class OffsetsFromMatchIterator
extends java.lang.Object
implements OffsetsRetrievalStrategy

This strategy retrieves offsets directly from MatchesIterator, if they are available, otherwise it falls back to using OffsetsFromPositions.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	field
private OffsetsFromPositions	noOffsetsFallback

Constructor Summary

Constructors

Constructor	Description
OffsetsFromMatchIterator(java.lang.String field, OffsetsFromPositions noOffsetsFallback)

Method Summary

Modifier and Type	Method	Description
java.util.List<OffsetRange>	get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)	Return value offsets (match ranges) acquired from the given MatchesIterator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

field

private final java.lang.String field

noOffsetsFallback

private final OffsetsFromPositions noOffsetsFallback

Constructor Detail

OffsetsFromMatchIterator

OffsetsFromMatchIterator(java.lang.String field,
                         OffsetsFromPositions noOffsetsFallback)

Method Detail

get

public java.util.List<OffsetRange> get(MatchesIterator matchesIterator,
                                       MatchRegionRetriever.FieldValueProvider doc)
                                throws java.io.IOException

Description copied from interface: OffsetsRetrievalStrategy

Return value offsets (match ranges) acquired from the given MatchesIterator.

Specified by:

get in interface OffsetsRetrievalStrategy

Throws:

java.io.IOException