org.apache.lucene.index
public interface TermDocs
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: IndexReader
Method Summary | |
---|---|
void | close() Frees associated resources. |
int | doc() Returns the current document number. |
int | freq() Returns the frequency of the term within the current document. |
boolean | next() Moves to the next pair in the enumeration. |
int | read(int[] docs, int[] freqs) Attempts to read multiple entries from the enumeration, up to length of
docs. |
void | seek(Term term) Sets this to the data for a term.
|
void | seek(TermEnum termEnum) Sets this to the data for the current term in a {@link TermEnum}.
|
boolean | skipTo(int target) Skips entries to the first beyond the current whose document number is
greater than or equal to target. |
This is invalid until {@link #next()} is called for the first time.
This is invalid until {@link #next()} is called for the first time.
Returns true iff there is such a next pair in the enumeration.
Returns the number of entries read. Zero is only returned when the stream has been exhausted.
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.