Documentation  › org.apache.lucene.index  › TermPositions
 
 


  TermPositions
  public abstract interface

  Inherits From:   none
  Conforms To:   TermDocs
  Declared In:   org.apache.lucene.index


Interface Description
 
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.



Class Variables
 
None declared in this interface.


Instance Variables
 
None declared in this interface.


Constructors
 
None declared in this interface.


Class Methods
 
None declared in this interface.


Instance Methods
 
nextPosition
public abstract 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.



Known Implementations
 
FilterIndexReader.FilterTermPositions, MultipleTermPositions



 
 
  dydoc
  3/9/05