Package org.apache.lucene.search.join
Class ToParentDocValues.NumDV
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.DocValuesIterator
-
- org.apache.lucene.index.NumericDocValues
-
- org.apache.lucene.search.join.ToParentDocValues.NumDV
-
- All Implemented Interfaces:
ToParentDocValues.Accumulator
- Enclosing class:
- ToParentDocValues
private static final class ToParentDocValues.NumDV extends NumericDocValues implements ToParentDocValues.Accumulator
-
-
Field Summary
Fields Modifier and Type Field Description private ToParentDocValues
iter
private BlockJoinSelector.Type
selection
private long
value
private NumericDocValues
values
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Modifier Constructor Description private
NumDV(NumericDocValues values, BlockJoinSelector.Type selection, BitSet parents, DocIdSetIterator children)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
advance(int targetParentDocID)
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)
Advance the iterator to exactlytarget
and return whethertarget
has a value.long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.void
increment()
long
longValue()
Returns the numeric value for the current document ID.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.void
reset()
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Field Detail
-
values
private final NumericDocValues values
-
value
private long value
-
selection
private final BlockJoinSelector.Type selection
-
iter
private final ToParentDocValues iter
-
-
Constructor Detail
-
NumDV
private NumDV(NumericDocValues values, BlockJoinSelector.Type selection, BitSet parents, DocIdSetIterator children)
-
-
Method Detail
-
reset
public void reset() throws java.io.IOException
- Specified by:
reset
in interfaceToParentDocValues.Accumulator
- Throws:
java.io.IOException
-
increment
public void increment() throws java.io.IOException
- Specified by:
increment
in interfaceToParentDocValues.Accumulator
- Throws:
java.io.IOException
-
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 targetParentDocID) 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
Description copied from class:DocValuesIterator
Advance the iterator to exactlytarget
and return whethertarget
has a value.target
must be greater than or equal to the currentdoc ID
and must be a valid doc ID, ie. ≥ 0 and <maxDoc
. After this method returns,DocIdSetIterator.docID()
returnstarget
.- Specified by:
advanceExact
in classDocValuesIterator
- Throws:
java.io.IOException
-
longValue
public long longValue()
Description copied from class:NumericDocValues
Returns the numeric value for the current document ID. It is illegal to call this method afterDocValuesIterator.advanceExact(int)
returnedfalse
.- Specified by:
longValue
in classNumericDocValues
- Returns:
- numeric value
-
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
-
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
-
-