Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

- Fixed class Javadoc (spelling, missing words), reformatted a bit. 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@149770 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Otis Gospodnetic 2002-06-05 17:12:59 +00:00
parent 8bcc042f5a
commit bd8c341d87
1 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/java/org/apache/lucene/index/TermPositions.java
View File

@ -58,18 +58,23 @@ import java.io.IOException;
import org.apache.lucene.document.Document; import org.apache.lucene.document.Document;
/** TermPositions provides an interface for enumerating the <document, /**
frequency, &lt;position&gt;* &gt; tuples for a term. <p> The document and * TermPositions provides an interface for enumerating the &lt;document,
frequency are as for a TermDocs. The positions portion lists the ordinal * frequency, &lt;position&gt;* &gt; tuples for a term. <p> The document and
positions of each occurence of a term in a document. * frequency are the same as for a TermDocs. The positions portion lists the ordinal
@see IndexReader#termPositions * positions of each occurrence of a term in a document.
*
* @see IndexReader#termPositions
*/ */
public interface TermPositions extends TermDocs { public interface TermPositions
extends TermDocs
{
/** Returns next position in the current document. It is an error to call /** Returns next position in the current document. It is an error to call
this more than {@link #freq()} times this more than {@link #freq()} times
without calling {@link #next()}<p> This is without calling {@link #next()}<p> This is
invalid until {@link #next()} is called for invalid until {@link #next()} is called for
the first time.*/ the first time.
*/
int nextPosition() throws IOException; int nextPosition() throws IOException;
} }