org.apache.lucene.index

Interface TermPositions

All Superinterfaces:
TermDocs
Known Implementing Classes:
FilterIndexReader.FilterTermPositions, MultipleTermPositions

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.

See Also:
IndexReader.termPositions()

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, seek, skipTo

Method Details

nextPosition

public int nextPosition()
            throws IOException
Returns next position in the current document. It is an error to call this more than freq() times without calling next()

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


Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.