Module org.apache.lucene.facet

Package org.apache.lucene.facet

Class DrillSidewaysScorer

java.lang.Object

org.apache.lucene.search.BulkScorer

org.apache.lucene.facet.DrillSidewaysScorer

class DrillSidewaysScorer
extends BulkScorer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	DrillSidewaysScorer.DocsAndCost
private final class	DrillSidewaysScorer.Score

Field Summary

Fields

Modifier and Type	Field	Description
private static final Comparator<DrillSidewaysScorer.DocsAndCost>	APPROXIMATION_COMPARATOR
private final DocIdSetIterator	baseApproximation
private final DocIdSetIterator	baseIterator
private final Scorer	baseScorer
private final TwoPhaseIterator	baseTwoPhase
private static final int	CHUNK
private int	collectDocID
private float	collectScore
private final LeafReaderContext	context
private final DrillSidewaysScorer.DocsAndCost[]	dims
private static final int	MASK
(package private) final boolean	scoreSubDocsAtOnce
private static final Comparator<DrillSidewaysScorer.DocsAndCost>	TWO_PHASE_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
DrillSidewaysScorer(LeafReaderContext context, Scorer baseScorer, DrillSidewaysScorer.DocsAndCost[] dims, boolean scoreSubDocsAtOnce)

Method Summary

Modifier and Type	Method	Description
private static int	advanceIfBehind(int docID, DocIdSetIterator iterator)
private void	collectHit(LeafCollector collector, List<DrillSidewaysScorer.DocsAndCost> dims)
private void	collectHit(LeafCollector collector, DrillSidewaysScorer.DocsAndCost dim)
private void	collectHit(LeafCollector collector, DrillSidewaysScorer.DocsAndCost[] dims)
private void	collectNearMiss(LeafCollector sidewaysCollector)
long	cost()	Same as DocIdSetIterator.cost() for bulk scorers.
private void	doDrillDownAdvanceScoring(Bits acceptDocs, LeafCollector collector, DrillSidewaysScorer.DocsAndCost[] dims)	Used when drill downs are highly constraining vs baseQuery.
private void	doQueryFirstScoring(Bits acceptDocs, LeafCollector collector, DrillSidewaysScorer.DocsAndCost[] dims)	Used when base query is highly constraining vs the drilldowns, or when the docs must be scored at once (i.e., like BooleanScorer2, not BooleanScorer).
private void	doQueryFirstScoringSingleDim(Bits acceptDocs, LeafCollector collector, DrillSidewaysScorer.DocsAndCost dim)	Query-first scoring specialization when there is only one drill-sideways dimension, which is likely a common scenario.
private void	doUnionScoring(Bits acceptDocs, LeafCollector collector, DrillSidewaysScorer.DocsAndCost[] dims)
private void	finish(DrillSidewaysScorer.DocsAndCost[] dims)
int	score(LeafCollector collector, Bits acceptDocs, int min, int maxDoc)	Collects matching documents in a range and return an estimation of the next matching document which is on or after max.
private void	setScorer(LeafCollector mainCollector, Scorable scorer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

APPROXIMATION_COMPARATOR

private static final Comparator<DrillSidewaysScorer.DocsAndCost> APPROXIMATION_COMPARATOR

TWO_PHASE_COMPARATOR

private static final Comparator<DrillSidewaysScorer.DocsAndCost> TWO_PHASE_COMPARATOR

dims

private final DrillSidewaysScorer.DocsAndCost[] dims

baseScorer

private final Scorer baseScorer

baseIterator

private final DocIdSetIterator baseIterator

baseApproximation

private final DocIdSetIterator baseApproximation

baseTwoPhase

private final TwoPhaseIterator baseTwoPhase

context

private final LeafReaderContext context

scoreSubDocsAtOnce

final boolean scoreSubDocsAtOnce

CHUNK

private static final int CHUNK

See Also:

• Constant Field Values

MASK

private static final int MASK

See Also:

• Constant Field Values

collectDocID

private int collectDocID

collectScore

private float collectScore

Constructor Details

DrillSidewaysScorer

DrillSidewaysScorer(LeafReaderContext context,
 Scorer baseScorer,
 DrillSidewaysScorer.DocsAndCost[] dims,
 boolean scoreSubDocsAtOnce)

Method Details

cost

public long cost()

Description copied from class: BulkScorer

Same as DocIdSetIterator.cost() for bulk scorers.

Specified by:

cost in class BulkScorer

score

public int score(LeafCollector collector,
 Bits acceptDocs,
 int min,
 int maxDoc)
          throws IOException

Description copied from class: BulkScorer

Collects matching documents in a range and return an estimation of the next matching document which is on or after max.

The return value must be:

• >= max,
• DocIdSetIterator.NO_MORE_DOCS if there are no more matches,
• <= the first matching document that is >= max otherwise.

min is the minimum document to be considered for matching. All documents strictly before this value must be ignored.

Although max would be a legal return value for this method, higher values might help callers skip more efficiently over non-matching portions of the docID space.

For instance, a Scorer-based implementation could look like below:

 private final Scorer scorer; // set via constructor

 public int score(LeafCollector collector, Bits acceptDocs, int min, int max) throws IOException {
   collector.setScorer(scorer);
   int doc = scorer.docID();
   if (doc < min) {
     doc = scorer.advance(min);
   }
   while (doc < max) {
     if (acceptDocs == null || acceptDocs.get(doc)) {
       collector.collect(doc);
     }
     doc = scorer.nextDoc();
   }
   return doc;
 }
 

Specified by:

score in class BulkScorer

Parameters:

collector - The collector to which all matching documents are passed.

acceptDocs - Bits that represents the allowed documents to match, or null if they are all allowed to match.

min - Score starting at, including, this document

maxDoc - Score up to, but not including, this doc

Returns:

an under-estimation of the next matching doc after max

Throws:

IOException

doQueryFirstScoringSingleDim

private void doQueryFirstScoringSingleDim(Bits acceptDocs,
 LeafCollector collector,
 DrillSidewaysScorer.DocsAndCost dim)
                                   throws IOException

Query-first scoring specialization when there is only one drill-sideways dimension, which is likely a common scenario.

Throws:

IOException

doQueryFirstScoring

private void doQueryFirstScoring(Bits acceptDocs,
 LeafCollector collector,
 DrillSidewaysScorer.DocsAndCost[] dims)
                          throws IOException

Used when base query is highly constraining vs the drilldowns, or when the docs must be scored at once (i.e., like BooleanScorer2, not BooleanScorer).

Throws:

IOException

advanceIfBehind

private static int advanceIfBehind(int docID,
 DocIdSetIterator iterator)
                            throws IOException

Throws:

IOException

doDrillDownAdvanceScoring

private void doDrillDownAdvanceScoring(Bits acceptDocs,
 LeafCollector collector,
 DrillSidewaysScorer.DocsAndCost[] dims)
                                throws IOException

Used when drill downs are highly constraining vs baseQuery.

Throws:

IOException

doUnionScoring

private void doUnionScoring(Bits acceptDocs,
 LeafCollector collector,
 DrillSidewaysScorer.DocsAndCost[] dims)
                     throws IOException

Throws:

IOException

collectHit

private void collectHit(LeafCollector collector,
 DrillSidewaysScorer.DocsAndCost[] dims)
                 throws IOException

Throws:

IOException

collectHit

private void collectHit(LeafCollector collector,
 DrillSidewaysScorer.DocsAndCost dim)
                 throws IOException

Throws:

IOException

collectHit

private void collectHit(LeafCollector collector,
 List<DrillSidewaysScorer.DocsAndCost> dims)
                 throws IOException

Throws:

IOException

collectNearMiss

private void collectNearMiss(LeafCollector sidewaysCollector)
                      throws IOException

Throws:

IOException

finish

private void finish(DrillSidewaysScorer.DocsAndCost[] dims)
             throws IOException

Throws:

IOException

setScorer

private void setScorer(LeafCollector mainCollector,
 Scorable scorer)
                throws IOException

Throws:

IOException