Package org.apache.lucene.search
Class FilterMatchesIterator
- java.lang.Object
-
- org.apache.lucene.search.FilterMatchesIterator
-
- All Implemented Interfaces:
MatchesIterator
public abstract class FilterMatchesIterator extends Object implements MatchesIterator
A MatchesIterator that delegates all calls to another MatchesIterator
-
-
Field Summary
Fields Modifier and Type Field Description protected MatchesIterator
in
The delegate
-
Constructor Summary
Constructors Modifier Constructor Description protected
FilterMatchesIterator(MatchesIterator in)
Create a new FilterMatchesIterator
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
endOffset()
The ending offset of the current match, or-1
if offsets are not available Should only be called afterMatchesIterator.next()
has returnedtrue
int
endPosition()
The end position of the current match Should only be called afterMatchesIterator.next()
has returnedtrue
Query
getQuery()
Returns the Query causing the current match If thisMatchesIterator
has been returned from aMatchesIterator.getSubMatches()
call, then returns aTermQuery
equivalent to the current match Should only be called afterMatchesIterator.next()
has returnedtrue
MatchesIterator
getSubMatches()
Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match Returnsnull
if there are no submatches (ie the current iterator is at the leaf level) Should only be called afterMatchesIterator.next()
has returnedtrue
boolean
next()
Advance the iterator to the next match positionint
startOffset()
The starting offset of the current match, or-1
if offsets are not available Should only be called afterMatchesIterator.next()
has returnedtrue
int
startPosition()
The start position of the current match Should only be called afterMatchesIterator.next()
has returnedtrue
-
-
-
Field Detail
-
in
protected final MatchesIterator in
The delegate
-
-
Constructor Detail
-
FilterMatchesIterator
protected FilterMatchesIterator(MatchesIterator in)
Create a new FilterMatchesIterator- Parameters:
in
- the delegate
-
-
Method Detail
-
next
public boolean next() throws IOException
Description copied from interface:MatchesIterator
Advance the iterator to the next match position- Specified by:
next
in interfaceMatchesIterator
- Returns:
true
if matches have not been exhausted- Throws:
IOException
-
startPosition
public int startPosition()
Description copied from interface:MatchesIterator
The start position of the current match Should only be called afterMatchesIterator.next()
has returnedtrue
- Specified by:
startPosition
in interfaceMatchesIterator
-
endPosition
public int endPosition()
Description copied from interface:MatchesIterator
The end position of the current match Should only be called afterMatchesIterator.next()
has returnedtrue
- Specified by:
endPosition
in interfaceMatchesIterator
-
startOffset
public int startOffset() throws IOException
Description copied from interface:MatchesIterator
The starting offset of the current match, or-1
if offsets are not available Should only be called afterMatchesIterator.next()
has returnedtrue
- Specified by:
startOffset
in interfaceMatchesIterator
- Throws:
IOException
-
endOffset
public int endOffset() throws IOException
Description copied from interface:MatchesIterator
The ending offset of the current match, or-1
if offsets are not available Should only be called afterMatchesIterator.next()
has returnedtrue
- Specified by:
endOffset
in interfaceMatchesIterator
- Throws:
IOException
-
getSubMatches
public MatchesIterator getSubMatches() throws IOException
Description copied from interface:MatchesIterator
Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match Returnsnull
if there are no submatches (ie the current iterator is at the leaf level) Should only be called afterMatchesIterator.next()
has returnedtrue
- Specified by:
getSubMatches
in interfaceMatchesIterator
- Throws:
IOException
-
getQuery
public Query getQuery()
Description copied from interface:MatchesIterator
Returns the Query causing the current match If thisMatchesIterator
has been returned from aMatchesIterator.getSubMatches()
call, then returns aTermQuery
equivalent to the current match Should only be called afterMatchesIterator.next()
has returnedtrue
- Specified by:
getQuery
in interfaceMatchesIterator
-
-