- java.lang.Object
-
- org.apache.lucene.search.TermMatchesIterator
-
- All Implemented Interfaces:
MatchesIterator
class TermMatchesIterator extends java.lang.Object implements MatchesIterator
AMatchesIterator
over a single term's postings list
-
-
Constructor Summary
Constructors Constructor Description TermMatchesIterator(Query query, PostingsEnum pe)
Create a newTermMatchesIterator
for the given term and postings list
-
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 availableint
endPosition()
The end position of the current matchQuery
getQuery()
Returns the Query causing the current matchMatchesIterator
getSubMatches()
Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current matchboolean
next()
Advance the iterator to the next match positionint
startOffset()
The starting offset of the current match, or-1
if offsets are not availableint
startPosition()
The start position of the current match
-
-
-
Field Detail
-
upto
private int upto
-
pos
private int pos
-
pe
private final PostingsEnum pe
-
query
private final Query query
-
-
Constructor Detail
-
TermMatchesIterator
TermMatchesIterator(Query query, PostingsEnum pe) throws java.io.IOException
Create a newTermMatchesIterator
for the given term and postings list- Throws:
java.io.IOException
-
-
Method Detail
-
next
public boolean next() throws java.io.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:
java.io.IOException
-
startPosition
public int startPosition()
Description copied from interface:MatchesIterator
The start position of the current matchShould only be called after
MatchesIterator.next()
has returnedtrue
- Specified by:
startPosition
in interfaceMatchesIterator
-
endPosition
public int endPosition()
Description copied from interface:MatchesIterator
The end position of the current matchShould only be called after
MatchesIterator.next()
has returnedtrue
- Specified by:
endPosition
in interfaceMatchesIterator
-
startOffset
public int startOffset() throws java.io.IOException
Description copied from interface:MatchesIterator
The starting offset of the current match, or-1
if offsets are not availableShould only be called after
MatchesIterator.next()
has returnedtrue
- Specified by:
startOffset
in interfaceMatchesIterator
- Throws:
java.io.IOException
-
endOffset
public int endOffset() throws java.io.IOException
Description copied from interface:MatchesIterator
The ending offset of the current match, or-1
if offsets are not availableShould only be called after
MatchesIterator.next()
has returnedtrue
- Specified by:
endOffset
in interfaceMatchesIterator
- Throws:
java.io.IOException
-
getSubMatches
public MatchesIterator getSubMatches() throws java.io.IOException
Description copied from interface:MatchesIterator
Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current matchReturns
null
if there are no submatches (ie the current iterator is at the leaf level)Should only be called after
MatchesIterator.next()
has returnedtrue
- Specified by:
getSubMatches
in interfaceMatchesIterator
- Throws:
java.io.IOException
-
getQuery
public Query getQuery()
Description copied from interface:MatchesIterator
Returns the Query causing the current matchIf this
MatchesIterator
has been returned from aMatchesIterator.getSubMatches()
call, then returns aTermQuery
equivalent to the current matchShould only be called after
MatchesIterator.next()
has returnedtrue
- Specified by:
getQuery
in interfaceMatchesIterator
-
-