FileDocCategorySizeDatePackage
TermDocs.javaAPI DocApache Lucene 2.1.03088Wed Feb 14 10:46:40 GMT 2007org.apache.lucene.index

TermDocs

public interface TermDocs
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
IndexReader#termDocs()

Fields Summary
Constructors Summary
Methods Summary
public voidclose()
Frees associated resources.

public intdoc()
Returns the current document number.

This is invalid until {@link #next()} is called for the first time.

public intfreq()
Returns the frequency of the term within the current document.

This is invalid until {@link #next()} is called for the first time.

public booleannext()
Moves to the next pair in the enumeration.

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

public intread(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.

public voidseek(org.apache.lucene.index.Term term)
Sets this to the data for a term. The enumeration is reset to the start of the data for this term.

public voidseek(org.apache.lucene.index.TermEnum termEnum)
Sets this to the data for the current term in a {@link TermEnum}. This may be optimized in some implementations.

public booleanskipTo(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.