org.apache.lucene.index
Interface TermPositions

All Superinterfaces:

TermDocs

public interface TermPositions

extends TermDocs

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

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

See Also:

IndexReader.termPositions(org.apache.lucene.index.Term)

Method Summary

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

Methods inherited from interface org.apache.lucene.index.TermDocs

close, doc, freq, next, read, seek, skipTo

Method Detail

nextPosition

public int nextPosition()
                 throws IOException

Returns next position in the current document. It is an error to call this more than TermDocs.freq() times without calling TermDocs.next()

This is invalid until TermDocs.next() is called for the first time.