Package org.apache.lucene.search.join
Class ToParentBlockJoinQuery.BlockJoinScorer
- java.lang.Object
-
- org.apache.lucene.search.Scorable
-
- org.apache.lucene.search.Scorer
-
- org.apache.lucene.search.join.ToParentBlockJoinQuery.BlockJoinScorer
-
- Enclosing class:
- ToParentBlockJoinQuery
static class ToParentBlockJoinQuery.BlockJoinScorer 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 private DocIdSetIterator
childApproximation
private Scorer
childScorer
private TwoPhaseIterator
childTwoPhase
private ToParentBlockJoinQuery.ParentApproximation
parentApproximation
private BitSet
parentBits
private ToParentBlockJoinQuery.ParentTwoPhase
parentTwoPhase
private float
score
private ScoreMode
scoreMode
-
Constructor Summary
Constructors Constructor Description BlockJoinScorer(Weight weight, Scorer childScorer, BitSet parentBits, ScoreMode scoreMode)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
docID()
Returns the doc ID that is currently being scored.Explanation
explain(LeafReaderContext context, Weight childWeight)
java.util.Collection<Scorable.ChildScorable>
getChildren()
Returns child sub-scorers positioned on the current documentfloat
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.void
setMinCompetitiveScore(float minScore)
Optional method: Tell the scorer that its iterator may safely ignore all documents whose score is less than the givenminScore
.private void
setScoreAndFreq()
TwoPhaseIterator
twoPhaseIterator()
Optional method: Return aTwoPhaseIterator
view of thisScorer
.-
Methods inherited from class org.apache.lucene.search.Scorer
advanceShallow, getWeight
-
-
-
-
Field Detail
-
childScorer
private final Scorer childScorer
-
parentBits
private final BitSet parentBits
-
scoreMode
private final ScoreMode scoreMode
-
childApproximation
private final DocIdSetIterator childApproximation
-
childTwoPhase
private final TwoPhaseIterator childTwoPhase
-
parentApproximation
private final ToParentBlockJoinQuery.ParentApproximation parentApproximation
-
parentTwoPhase
private final ToParentBlockJoinQuery.ParentTwoPhase parentTwoPhase
-
score
private float score
-
-
Method Detail
-
getChildren
public java.util.Collection<Scorable.ChildScorable> getChildren()
Description copied from class:Scorable
Returns child sub-scorers positioned on the current document- Overrides:
getChildren
in classScorable
-
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 returnedTwoPhaseIterator
'sapproximation
must advance synchronously with theScorer.iterator()
: advancing the approximation must advance the iterator and vice-versa. Implementing this method is typically useful onScorer
s that have a high per-document overhead in order to confirm matches. The default implementation returnsnull
.- Overrides:
twoPhaseIterator
in classScorer
-
docID
public int docID()
Description copied from class:Scorable
Returns the doc ID that is currently being scored.
-
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
-
setMinCompetitiveScore
public void setMinCompetitiveScore(float minScore) throws java.io.IOException
Description copied from class:Scorable
Optional method: Tell the scorer that its iterator may safely ignore all documents whose score is less than the givenminScore
. This is a no-op by default. This method may only be called from collectors that useScoreMode.TOP_SCORES
, and successive calls may only set increasing values ofminScore
.- Overrides:
setMinCompetitiveScore
in classScorable
- Throws:
java.io.IOException
-
setScoreAndFreq
private void setScoreAndFreq() throws java.io.IOException
- Throws:
java.io.IOException
-
explain
public Explanation explain(LeafReaderContext context, Weight childWeight) throws java.io.IOException
- Throws:
java.io.IOException
-
-