public static class FilterIndexReader.FilterTermDocs extends java.lang.Object implements TermDocs
TermDocs
implementations.Constructor and Description |
---|
FilterTermDocs(TermDocs in) |
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 i)
Skips entries to the first beyond the current whose document number is
greater than or equal to target.
|
protected TermDocs in
public FilterTermDocs(TermDocs in)
public void seek(Term term) throws java.io.IOException
TermDocs
public void seek(TermEnum termEnum) throws java.io.IOException
TermDocs
TermEnum
.
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() throws java.io.IOException
TermDocs
Returns true iff there is such a next pair in the enumeration.
public int read(int[] docs, int[] freqs) throws java.io.IOException
TermDocs
Returns the number of entries read. Zero is only returned when the stream has been exhausted.
public boolean skipTo(int i) throws java.io.IOException
TermDocs
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.
Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.