org.apache.lucene.index

Interface TermPositions

public interface TermPositions extends 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.

Method Summary
int	nextPosition() Returns next position in the current document.

Method Detail

nextPosition

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.