public interface TermDocs extends Closeable
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.
IndexReader.termDocs()
Modifier and Type | Method and Description |
---|---|
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
TermEnum . |
boolean |
skipTo(int target)
Skips entries to the first beyond the current whose document number is
greater than or equal to target.
|
void seek(Term term) throws IOException
IOException
void seek(TermEnum termEnum) throws IOException
TermEnum
.
This may be optimized in some implementations.IOException
int doc()
This is invalid until next()
is called for the first time.
int freq()
This
is invalid until next()
is called for the first time.
boolean next() throws IOException
Returns true iff there is such a next pair in the enumeration.
IOException
int read(int[] docs, int[] freqs) throws IOException
Returns the number of entries read. Zero is only returned when the stream has been exhausted.
IOException
boolean skipTo(int target) throws IOException
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.
IOException
void close() throws IOException
close
in interface Closeable
IOException