File Doc Category Size Date Package
TermPositions.java API Doc Apache Lucene 2.1.0 1538 Wed Feb 14 10:46:40 GMT 2007 org.apache.lucene.index

TermPositions

public interface TermPositions implements TermDocs

TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term.

The document and frequency are the same as for a TermDocs. The positions portion lists the ordinal positions of each occurrence of a term in a document.

see: IndexReader#termPositions()

Fields Summary
Constructors Summary
Methods Summary
public int nextPosition()
Returns next position in the current document. It is an error to call this more than {@link #freq()} times without calling {@link #next()}
This is invalid until {@link #next()} is called for the first time.