org.apache.lucene.search.intervals

Interface IntervalMatchesIterator

All Superinterfaces:

MatchesIterator

All Known Implementing Classes:

MinimizingConjunctionMatchesIterator, MinimumShouldMatchIntervalsSource.MinimumMatchesIterator

interface IntervalMatchesIterator
extends MatchesIterator

An extension of MatchesIterator that allows the gaps from a wrapped IntervalIterator to be reported. This is necessary because MatchesIterator.getSubMatches() returns the submatches of all nested matches as a flat iterator, but IntervalIterator.gaps() only returns the gaps between its immediate sub-matches, so we can't calculate the latter using the former.

Method Summary

Modifier and Type	Method and Description
int	gaps() The number of top-level gaps inside the current match

Methods inherited from interface org.apache.lucene.search.MatchesIterator

endOffset, endPosition, getQuery, getSubMatches, next, startOffset, startPosition

Method Detail

gaps

int gaps()

The number of top-level gaps inside the current match