Package org.apache.lucene.search

Class TermMatchesIterator

java.lang.Object

org.apache.lucene.search.TermMatchesIterator

All Implemented Interfaces:

MatchesIterator

class TermMatchesIterator
extends java.lang.Object
implements MatchesIterator

A MatchesIterator over a single term's postings list

Field Summary

Fields

Modifier and Type	Field	Description
private PostingsEnum	pe
private int	pos
private Query	query
private int	upto

Constructor Summary

Constructors

Constructor	Description
TermMatchesIterator(Query query, PostingsEnum pe)	Create a new TermMatchesIterator for the given term and postings list

Method Summary

Modifier and Type	Method	Description
int	endOffset()	The ending offset of the current match, or -1 if offsets are not available
int	endPosition()	The end position of the current match
Query	getQuery()	Returns the Query causing the current match
MatchesIterator	getSubMatches()	Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match
boolean	next()	Advance the iterator to the next match position
int	startOffset()	The starting offset of the current match, or -1 if offsets are not available
int	startPosition()	The start position of the current match

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 new TermMatchesIterator 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 interface MatchesIterator

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 match

Should only be called after MatchesIterator.next() has returned true

Specified by:

startPosition in interface MatchesIterator

endPosition

public int endPosition()

Description copied from interface: MatchesIterator

The end position of the current match

Should only be called after MatchesIterator.next() has returned true

Specified by:

endPosition in interface MatchesIterator

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 available

Should only be called after MatchesIterator.next() has returned true

Specified by:

startOffset in interface MatchesIterator

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 available

Should only be called after MatchesIterator.next() has returned true

Specified by:

endOffset in interface MatchesIterator

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 match

Returns null if there are no submatches (ie the current iterator is at the leaf level)

Should only be called after MatchesIterator.next() has returned true

Specified by:

getSubMatches in interface MatchesIterator

Throws:

java.io.IOException

getQuery

public Query getQuery()

Description copied from interface: MatchesIterator

Returns the Query causing the current match

If this MatchesIterator has been returned from a MatchesIterator.getSubMatches() call, then returns a TermQuery equivalent to the current match

Should only be called after MatchesIterator.next() has returned true

Specified by:

getQuery in interface MatchesIterator