public class InstantiatedTermDocs extends Object implements TermDocs
TermDocs navigating an InstantiatedIndexReader.| Modifier and Type | Field and Description |
|---|---|
protected InstantiatedTermDocumentInformation |
currentDocumentInformation |
protected InstantiatedTerm |
currentTerm |
| Constructor and Description |
|---|
InstantiatedTermDocs(InstantiatedIndexReader reader) |
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Does nothing
|
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.
|
protected InstantiatedTermDocumentInformation currentDocumentInformation
protected InstantiatedTerm currentTerm
public InstantiatedTermDocs(InstantiatedIndexReader reader)
public void seek(Term term)
TermDocspublic void seek(TermEnum termEnum)
TermDocsTermEnum.
This may be optimized in some implementations.public 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()
TermDocsReturns true iff there is such a next pair in the enumeration. Once this returns false you should not call any of the other methods.
public int read(int[] docs,
int[] freqs)
TermDocsReturns the number of entries read. Zero is only returned when the stream has been exhausted.
public boolean skipTo(int target)
Returns true if there is such an entry.
Behaves as if written:
boolean skipTo(int target) {
do {
if (!next())
return false;
} while (target > doc());
return true;
}
This implementation is considerably more efficient than that.