Package org.apache.lucene.search.join
Class BaseGlobalOrdinalScorer
java.lang.Object
org.apache.lucene.search.Scorable
org.apache.lucene.search.Scorer
org.apache.lucene.search.join.BaseGlobalOrdinalScorer
- Direct Known Subclasses:
GlobalOrdinalsQuery.OrdinalMapScorer
,GlobalOrdinalsQuery.SegmentOrdinalScorer
,GlobalOrdinalsWithScoreQuery.OrdinalMapScorer
,GlobalOrdinalsWithScoreQuery.SegmentOrdinalScorer
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable
Scorable.ChildScorable
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final DocIdSetIterator
(package private) float
(package private) final SortedDocValues
-
Constructor Summary
ConstructorsConstructorDescriptionBaseGlobalOrdinalScorer
(Weight weight, SortedDocValues values, DocIdSetIterator approximationScorer) -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract TwoPhaseIterator
createTwoPhaseIterator
(DocIdSetIterator approximation) int
docID()
Returns the doc ID that is currently being scored.float
getMaxScore
(int upTo) Return the maximum score that documents between the lasttarget
that this iterator wasshallow-advanced
to included andupTo
included.iterator()
Return aDocIdSetIterator
over matching documents.float
score()
Returns the score of the current document matching the query.Optional method: Return aTwoPhaseIterator
view of thisScorer
.Methods inherited from class org.apache.lucene.search.Scorer
advanceShallow, getWeight
Methods inherited from class org.apache.lucene.search.Scorable
getChildren, setMinCompetitiveScore, smoothingScore
-
Field Details
-
values
-
approximation
-
score
float score
-
-
Constructor Details
-
BaseGlobalOrdinalScorer
public BaseGlobalOrdinalScorer(Weight weight, SortedDocValues values, DocIdSetIterator approximationScorer)
-
-
Method Details
-
score
Description copied from class:Scorable
Returns the score of the current document matching the query.- Specified by:
score
in classScorable
- Throws:
IOException
-
getMaxScore
Description copied from class:Scorer
Return the maximum score that documents between the lasttarget
that this iterator wasshallow-advanced
to included andupTo
included.- Specified by:
getMaxScore
in classScorer
- Throws:
IOException
-
docID
public int docID()Description copied from class:Scorable
Returns the doc ID that is currently being scored. -
iterator
Description copied from class:Scorer
Return aDocIdSetIterator
over matching documents.The returned iterator will either be positioned on
-1
if no documents have been scored yet,DocIdSetIterator.NO_MORE_DOCS
if all documents have been scored already, or the last document id that has been scored otherwise.The returned iterator is a view: calling this method several times will return iterators that have the same state.
-
twoPhaseIterator
Description copied from class:Scorer
Optional method: Return aTwoPhaseIterator
view of thisScorer
. A return value ofnull
indicates that two-phase iteration is not supported.Note that the returned
TwoPhaseIterator
'sapproximation
must advance synchronously with theScorer.iterator()
: advancing the approximation must advance the iterator and vice-versa.Implementing this method is typically useful on
Scorer
s that have a high per-document overhead in order to confirm matches.The default implementation returns
null
.- Overrides:
twoPhaseIterator
in classScorer
-
createTwoPhaseIterator
-