Module org.apache.lucene.core
Class TermOrdValComparator.CompetitiveIterator
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.search.comparators.TermOrdValComparator.CompetitiveIterator
-
- Enclosing class:
- TermOrdValComparator
private class TermOrdValComparator.CompetitiveIterator extends DocIdSetIterator
-
-
Field Summary
Fields Modifier and Type Field Description private LeafReaderContext
context
private boolean
dense
private PriorityQueue<TermOrdValComparator.PostingsEnumAndOrd>
disjunction
private int
doc
private DocIdSetIterator
docsWithField
private TermsEnum
docValuesTerms
private java.lang.String
field
private static int
MAX_TERMS
private int
maxDoc
private java.util.ArrayDeque<TermOrdValComparator.PostingsEnumAndOrd>
postings
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Constructor Description CompetitiveIterator(LeafReaderContext context, java.lang.String field, boolean dense, TermsEnum docValuesTerms)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
advance(int target)
Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.private void
init(int minOrd, int maxOrd)
For the first time, this iterator is allowed to skip documents.int
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.private void
update(int minOrd, int maxOrd)
Update this iterator to only match postings whose term has an ordinal betweenminOrd
included andmaxOrd
included.-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Field Detail
-
MAX_TERMS
private static final int MAX_TERMS
- See Also:
- Constant Field Values
-
context
private final LeafReaderContext context
-
maxDoc
private final int maxDoc
-
field
private final java.lang.String field
-
dense
private final boolean dense
-
docValuesTerms
private final TermsEnum docValuesTerms
-
doc
private int doc
-
postings
private java.util.ArrayDeque<TermOrdValComparator.PostingsEnumAndOrd> postings
-
docsWithField
private DocIdSetIterator docsWithField
-
disjunction
private PriorityQueue<TermOrdValComparator.PostingsEnumAndOrd> disjunction
-
-
Constructor Detail
-
CompetitiveIterator
CompetitiveIterator(LeafReaderContext context, java.lang.String field, boolean dense, TermsEnum docValuesTerms)
-
-
Method Detail
-
docID
public int docID()
Description copied from class:DocIdSetIterator
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.- Otherwise it should return the doc ID it is currently on.
- Specified by:
docID
in classDocIdSetIterator
-
nextDoc
public int nextDoc() throws java.io.IOException
Description copied from class:DocIdSetIterator
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.- Specified by:
nextDoc
in classDocIdSetIterator
- Throws:
java.io.IOException
-
advance
public int advance(int target) throws java.io.IOException
Description copied from class:DocIdSetIterator
Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returnsDocIdSetIterator.NO_MORE_DOCS
if target is greater than the highest document number in the set.The behavior of this method is undefined when called with
target ≤ current
, or after the iterator has exhausted. Both cases may result in unpredicted behavior.When
target > current
it behaves as if written:int advance(int target) { int doc; while ((doc = nextDoc()) < target) { } return doc; }
Some implementations are considerably more efficient than that.NOTE: this method may be called with
DocIdSetIterator.NO_MORE_DOCS
for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.- Specified by:
advance
in classDocIdSetIterator
- Throws:
java.io.IOException
-
cost
public long cost()
Description copied from class:DocIdSetIterator
Returns the estimated cost of thisDocIdSetIterator
.This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.
- Specified by:
cost
in classDocIdSetIterator
-
update
private void update(int minOrd, int maxOrd) throws java.io.IOException
Update this iterator to only match postings whose term has an ordinal betweenminOrd
included andmaxOrd
included.- Throws:
java.io.IOException
-
init
private void init(int minOrd, int maxOrd) throws java.io.IOException
For the first time, this iterator is allowed to skip documents. It needs to pullPostingsEnum
s from the terms dictionary of the inverted index and create a priority queue out of them.- Throws:
java.io.IOException
-
-