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.

Namespace:
Assembly: Lucene.Net.NetCore.dll
Syntax
public interface TermDocs : IDisposable

Properties

Name Description
Doc

Returns the current document number.

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

Returns the frequency of the term within the current document.

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

Methods

Name Description
Close()

Frees associated resources.

Next()

Moves to the next pair in the enumeration.

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

Read(Int32[], Int32[])

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.

Seek(Term)

Sets this to the data for a term. The enumeration is reset to the start of the data for this term.
Seek(TermEnum)

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

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.

See Also