public abstract class AbstractAllTermDocs extends Object implements TermDocs
NOTE: this class is meant only to be used internally by Lucene; it's only public so it can be shared across packages. This means the API is freely subject to change, and, the class could be removed entirely, in any Lucene release. Use directly at your own risk!
| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAllTermDocs(int maxDoc) |
| 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.
|
abstract boolean |
isDeleted(int doc) |
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.
|
public void seek(Term term) throws IOException
TermDocsseek in interface TermDocsIOExceptionpublic void seek(TermEnum termEnum) throws IOException
TermDocsTermEnum.
This may be optimized in some implementations.seek in interface TermDocsIOExceptionpublic int doc()
TermDocs This is invalid until TermDocs.next() is called for the first time.
public int freq()
TermDocs This
is invalid until TermDocs.next() is called for the first time.
public boolean next()
throws IOException
TermDocsReturns true iff there is such a next pair in the enumeration.
next in interface TermDocsIOExceptionpublic int read(int[] docs,
int[] freqs)
throws IOException
TermDocsReturns the number of entries read. Zero is only returned when the stream has been exhausted.
read in interface TermDocsIOExceptionpublic boolean skipTo(int target)
throws IOException
TermDocsReturns 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.skipTo in interface TermDocsIOExceptionpublic void close()
throws IOException
TermDocsclose in interface Closeableclose in interface TermDocsIOExceptionpublic abstract boolean isDeleted(int doc)