- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.search.join.ToParentDocValues
-
class ToParentDocValues extends DocIdSetIterator
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static interface
ToParentDocValues.Accumulator
private static class
ToParentDocValues.NumDV
private static class
ToParentDocValues.SortedDVs
-
Field Summary
Fields Modifier and Type Field Description private DocIdSetIterator
childWithValues
private ToParentDocValues.Accumulator
collector
private int
docID
private BitSet
parents
(package private) boolean
seen
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Modifier Constructor Description private
ToParentDocValues(DocIdSetIterator values, BitSet parents, DocIdSetIterator children, ToParentDocValues.Accumulator collect)
-
Method Summary
All Methods Static 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.boolean
advanceExact(int targetParentDocID)
long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.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.(package private) static NumericDocValues
wrap(NumericDocValues values, BlockJoinSelector.Type selection, BitSet parents2, DocIdSetIterator children)
(package private) static SortedDocValues
wrap(SortedDocValues values, BlockJoinSelector.Type selection, BitSet parents2, DocIdSetIterator children)
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Field Detail
-
parents
private final BitSet parents
-
docID
private int docID
-
collector
private final ToParentDocValues.Accumulator collector
-
seen
boolean seen
-
childWithValues
private DocIdSetIterator childWithValues
-
-
Constructor Detail
-
ToParentDocValues
private ToParentDocValues(DocIdSetIterator values, BitSet parents, DocIdSetIterator children, ToParentDocValues.Accumulator collect)
-
-
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
-
advanceExact
public boolean advanceExact(int targetParentDocID) throws java.io.IOException
- 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
-
wrap
static NumericDocValues wrap(NumericDocValues values, BlockJoinSelector.Type selection, BitSet parents2, DocIdSetIterator children)
-
wrap
static SortedDocValues wrap(SortedDocValues values, BlockJoinSelector.Type selection, BitSet parents2, DocIdSetIterator children)
-
-