Interface MatchesIterator
- All Known Implementing Classes:
FilterMatchesIterator
To iterate over the matches, call next() until it returns false, retrieving
positions and/or offsets after each call. You should not call the position or offset methods
before next() has been called, or after next() has returned false.
Matches from some queries may span multiple positions. You can retrieve the positions of
individual matching terms on the current match by calling getSubMatches().
Matches are ordered by start position, and then by end position. Match intervals may overlap.
- See Also:
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Method Summary
Modifier and TypeMethodDescriptionintThe ending offset of the current match, or-1if offsets are not availableintThe end position of the current match, or-1if positions are not availablegetQuery()Returns the Query causing the current matchReturns a MatchesIterator that iterates over the positions and offsets of individual terms within the current matchbooleannext()Advance the iterator to the next match positionintThe starting offset of the current match, or-1if offsets are not availableintThe start position of the current match, or-1if positions are not available
-
Method Details
-
next
Advance the iterator to the next match position- Returns:
trueif matches have not been exhausted- Throws:
IOException
-
startPosition
int startPosition()The start position of the current match, or-1if positions are not availableShould only be called after
next()has returnedtrue -
endPosition
int endPosition()The end position of the current match, or-1if positions are not availableShould only be called after
next()has returnedtrue -
startOffset
The starting offset of the current match, or-1if offsets are not availableShould only be called after
next()has returnedtrue- Throws:
IOException
-
endOffset
The ending offset of the current match, or-1if offsets are not availableShould only be called after
next()has returnedtrue- Throws:
IOException
-
getSubMatches
Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current matchReturns
nullif there are no submatches (ie the current iterator is at the leaf level)Should only be called after
next()has returnedtrue- Throws:
IOException
-
getQuery
Query getQuery()Returns the Query causing the current matchIf this
MatchesIteratorhas been returned from agetSubMatches()call, then returns aTermQueryequivalent to the current matchShould only be called after
next()has returnedtrue
-