- 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
abstract class BaseGlobalOrdinalScorer extends Scorer
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable
Scorable.ChildScorable
-
-
Field Summary
Fields Modifier and Type Field Description (package private) DocIdSetIterator
approximation
(package private) float
boost
(package private) float
score
(package private) SortedDocValues
values
-
Constructor Summary
Constructors Constructor Description BaseGlobalOrdinalScorer(Weight weight, SortedDocValues values, DocIdSetIterator approximationScorer, float boost)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected 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.DocIdSetIterator
iterator()
Return aDocIdSetIterator
over matching documents.float
score()
Returns the score of the current document matching the query.TwoPhaseIterator
twoPhaseIterator()
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 Detail
-
values
final SortedDocValues values
-
approximation
final DocIdSetIterator approximation
-
boost
final float boost
-
score
float score
-
-
Constructor Detail
-
BaseGlobalOrdinalScorer
public BaseGlobalOrdinalScorer(Weight weight, SortedDocValues values, DocIdSetIterator approximationScorer, float boost)
-
-
Method Detail
-
score
public float score() throws java.io.IOException
Description copied from class:Scorable
Returns the score of the current document matching the query.
-
getMaxScore
public float getMaxScore(int upTo) throws java.io.IOException
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:
java.io.IOException
-
docID
public int docID()
Description copied from class:Scorable
Returns the doc ID that is currently being scored.
-
iterator
public DocIdSetIterator 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
public TwoPhaseIterator 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
protected abstract TwoPhaseIterator createTwoPhaseIterator(DocIdSetIterator approximation)
-
-