Package org.apache.lucene.search
Class ConjunctionDISI
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.search.ConjunctionDISI
-
public final class ConjunctionDISI extends DocIdSetIterator
A conjunction of DocIdSetIterators. This iterates over the doc ids that are present in each given DocIdSetIterator.
Public only for use inorg.apache.lucene.search.spans
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
ConjunctionDISI.BitSetConjunctionDISI
Conjunction between aDocIdSetIterator
and one or moreBitSetIterator
s.private static class
ConjunctionDISI.ConjunctionTwoPhaseIterator
TwoPhaseIterator
implementing a conjunction.
-
Field Summary
Fields Modifier and Type Field Description (package private) DocIdSetIterator
lead1
(package private) DocIdSetIterator
lead2
(package private) DocIdSetIterator[]
others
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Modifier Constructor Description private
ConjunctionDISI(java.util.List<? extends DocIdSetIterator> iterators)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static void
addIterator(DocIdSetIterator disi, java.util.List<DocIdSetIterator> allIterators, java.util.List<TwoPhaseIterator> twoPhaseIterators)
private static void
addScorer(Scorer scorer, java.util.List<DocIdSetIterator> allIterators, java.util.List<TwoPhaseIterator> twoPhaseIterators)
Adds the scorer, possibly splitting up into two phases or collapsing if it is another conjunctionprivate static void
addSpans(Spans spans, java.util.List<DocIdSetIterator> allIterators, java.util.List<TwoPhaseIterator> twoPhaseIterators)
Adds the Spans.private static void
addTwoPhaseIterator(TwoPhaseIterator twoPhaseIter, java.util.List<DocIdSetIterator> allIterators, java.util.List<TwoPhaseIterator> twoPhaseIterators)
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
.private static DocIdSetIterator
createConjunction(java.util.List<DocIdSetIterator> allIterators, java.util.List<TwoPhaseIterator> twoPhaseIterators)
int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.private int
doNext(int doc)
static DocIdSetIterator
intersectIterators(java.util.List<DocIdSetIterator> iterators)
Create a conjunction over the provided DocIdSetIterators.static DocIdSetIterator
intersectScorers(java.util.Collection<Scorer> scorers)
Create a conjunction over the providedScorer
s.static DocIdSetIterator
intersectSpans(java.util.List<Spans> spanList)
Create a conjunction over the providedSpans
.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.-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Field Detail
-
lead1
final DocIdSetIterator lead1
-
lead2
final DocIdSetIterator lead2
-
others
final DocIdSetIterator[] others
-
-
Constructor Detail
-
ConjunctionDISI
private ConjunctionDISI(java.util.List<? extends DocIdSetIterator> iterators)
-
-
Method Detail
-
intersectScorers
public static DocIdSetIterator intersectScorers(java.util.Collection<Scorer> scorers)
Create a conjunction over the providedScorer
s. Note that the returnedDocIdSetIterator
might leverage two-phase iteration in which case it is possible to retrieve theTwoPhaseIterator
usingTwoPhaseIterator.unwrap(org.apache.lucene.search.DocIdSetIterator)
.
-
intersectIterators
public static DocIdSetIterator intersectIterators(java.util.List<DocIdSetIterator> iterators)
Create a conjunction over the provided DocIdSetIterators. Note that the returnedDocIdSetIterator
might leverage two-phase iteration in which case it is possible to retrieve theTwoPhaseIterator
usingTwoPhaseIterator.unwrap(org.apache.lucene.search.DocIdSetIterator)
.
-
intersectSpans
public static DocIdSetIterator intersectSpans(java.util.List<Spans> spanList)
Create a conjunction over the providedSpans
. Note that the returnedDocIdSetIterator
might leverage two-phase iteration in which case it is possible to retrieve theTwoPhaseIterator
usingTwoPhaseIterator.unwrap(org.apache.lucene.search.DocIdSetIterator)
.
-
addScorer
private static void addScorer(Scorer scorer, java.util.List<DocIdSetIterator> allIterators, java.util.List<TwoPhaseIterator> twoPhaseIterators)
Adds the scorer, possibly splitting up into two phases or collapsing if it is another conjunction
-
addSpans
private static void addSpans(Spans spans, java.util.List<DocIdSetIterator> allIterators, java.util.List<TwoPhaseIterator> twoPhaseIterators)
Adds the Spans.
-
addIterator
private static void addIterator(DocIdSetIterator disi, java.util.List<DocIdSetIterator> allIterators, java.util.List<TwoPhaseIterator> twoPhaseIterators)
-
addTwoPhaseIterator
private static void addTwoPhaseIterator(TwoPhaseIterator twoPhaseIter, java.util.List<DocIdSetIterator> allIterators, java.util.List<TwoPhaseIterator> twoPhaseIterators)
-
createConjunction
private static DocIdSetIterator createConjunction(java.util.List<DocIdSetIterator> allIterators, java.util.List<TwoPhaseIterator> twoPhaseIterators)
-
doNext
private int doNext(int doc) throws java.io.IOException
- 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
-
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
-
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
-
-