Package org.apache.lucene.search
Class FilterMatchesIterator
java.lang.Object
org.apache.lucene.search.FilterMatchesIterator
- All Implemented Interfaces:
MatchesIterator
A MatchesIterator that delegates all calls to another MatchesIterator
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCreate a new FilterMatchesIterator -
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
-
Field Details
-
in
The delegate
-
-
Constructor Details
-
FilterMatchesIterator
Create a new FilterMatchesIterator- Parameters:
in- the delegate
-
-
Method Details
-
next
Description copied from interface:MatchesIteratorAdvance the iterator to the next match position- Specified by:
nextin interfaceMatchesIterator- Returns:
trueif matches have not been exhausted- Throws:
IOException
-
startPosition
public int startPosition()Description copied from interface:MatchesIteratorThe start position of the current match, or-1if positions are not availableShould only be called after
MatchesIterator.next()has returnedtrue- Specified by:
startPositionin interfaceMatchesIterator
-
endPosition
public int endPosition()Description copied from interface:MatchesIteratorThe end position of the current match, or-1if positions are not availableShould only be called after
MatchesIterator.next()has returnedtrue- Specified by:
endPositionin interfaceMatchesIterator
-
startOffset
Description copied from interface:MatchesIteratorThe starting offset of the current match, or-1if offsets are not availableShould only be called after
MatchesIterator.next()has returnedtrue- Specified by:
startOffsetin interfaceMatchesIterator- Throws:
IOException
-
endOffset
Description copied from interface:MatchesIteratorThe ending offset of the current match, or-1if offsets are not availableShould only be called after
MatchesIterator.next()has returnedtrue- Specified by:
endOffsetin interfaceMatchesIterator- Throws:
IOException
-
getSubMatches
Description copied from interface:MatchesIteratorReturns 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
MatchesIterator.next()has returnedtrue- Specified by:
getSubMatchesin interfaceMatchesIterator- Throws:
IOException
-
getQuery
Description copied from interface:MatchesIteratorReturns the Query causing the current matchIf this
MatchesIteratorhas been returned from aMatchesIterator.getSubMatches()call, then returns aTermQueryequivalent to the current matchShould only be called after
MatchesIterator.next()has returnedtrue- Specified by:
getQueryin interfaceMatchesIterator
-