public interface

TermDocs

implements Closeable
org.apache.lucene.index.TermDocs
Known Indirect Subclasses

Class Overview

TermDocs provides an interface for enumerating <document, frequency> pairs for a term.

The document portion names each document containing the term. Documents are indicated by number. The frequency portion gives the number of times the term occurred in each document.

The pairs are ordered by document number.

See Also

Summary

Public Methods
abstract void close()
Frees associated resources.
abstract int doc()
Returns the current document number.
abstract int freq()
Returns the frequency of the term within the current document.
abstract boolean next()
Moves to the next pair in the enumeration.
abstract int read(int[] docs, int[] freqs)
Attempts to read multiple entries from the enumeration, up to length of docs.
abstract void seek(TermEnum termEnum)
Sets this to the data for the current term in a TermEnum.
abstract void seek(Term term)
Sets this to the data for a term.
abstract boolean skipTo(int target)
Skips entries to the first beyond the current whose document number is greater than or equal to target.
[Expand]
Inherited Methods
From interface java.io.Closeable

Public Methods

public abstract void close ()

Frees associated resources.

Throws
IOException

public abstract int doc ()

Returns the current document number.

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

public abstract int freq ()

Returns the frequency of the term within the current document.

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

public abstract boolean next ()

Moves to the next pair in the enumeration.

Returns true iff there is such a next pair in the enumeration.

Throws
IOException

public abstract int read (int[] docs, int[] freqs)

Attempts to read multiple entries from the enumeration, up to length of docs. Document numbers are stored in docs, and term frequencies are stored in freqs. The freqs array must be as long as the docs array.

Returns the number of entries read. Zero is only returned when the stream has been exhausted.

Throws
IOException

public abstract void seek (TermEnum termEnum)

Sets this to the data for the current term in a TermEnum. This may be optimized in some implementations.

Throws
IOException

public abstract void seek (Term term)

Sets this to the data for a term. The enumeration is reset to the start of the data for this term.

Throws
IOException

public abstract boolean skipTo (int target)

Skips entries to the first beyond the current whose document number is greater than or equal to target.

Returns true iff there is such an entry.

Behaves as if written: 

   boolean skipTo(int target) {
     do {
       if (!next())
 	     return false;
     } while (target > doc());
     return true;
   }
Some implementations are considerably more efficient than that.

Throws
IOException