org.apache.lucene.search
Class CheckHits.ExplanationAsserter

java.lang.Object
  org.apache.lucene.search.Collector
      org.apache.lucene.search.CheckHits.ExplanationAsserter

Enclosing class:

CheckHits

public static class CheckHits.ExplanationAsserter
extends Collector

Asserts that the score explanation for every document matching a query corresponds with the true score. NOTE: this HitCollector should only be used with the Query and Searcher specified at when it is constructed.

See Also:

CheckHits.verifyExplanation(java.lang.String, int, float, boolean, org.apache.lucene.search.Explanation)

Field Summary

static float

SCORE_TOLERANCE_DELTA Deprecated.

Constructor Summary

CheckHits.ExplanationAsserter(Query q, String defaultFieldName, Searcher s)
Constructs an instance which does shallow tests on the Explanation

CheckHits.ExplanationAsserter(Query q, String defaultFieldName, Searcher s, boolean deep)

Method Summary

boolean	acceptsDocsOutOfOrder() Return true if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to Collector.collect(int).
void	collect(int doc) Called once for every document matching a query, with the unbased document number.
void	setNextReader(IndexReader reader, int docBase) Called before collecting from each IndexReader.
void	setScorer(Scorer scorer) Called before successive calls to Collector.collect(int).

Methods inherited from class java.lang.Object

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

Field Detail

SCORE_TOLERANCE_DELTA

@Deprecated
public static float SCORE_TOLERANCE_DELTA

Deprecated.

See Also:

CheckHits.EXPLAIN_SCORE_TOLERANCE_DELTA

Constructor Detail

CheckHits.ExplanationAsserter

public CheckHits.ExplanationAsserter(Query q,
                                     String defaultFieldName,
                                     Searcher s)

Constructs an instance which does shallow tests on the Explanation

CheckHits.ExplanationAsserter

public CheckHits.ExplanationAsserter(Query q,
                                     String defaultFieldName,
                                     Searcher s,
                                     boolean deep)

Method Detail

setScorer

public void setScorer(Scorer scorer)
               throws IOException

Description copied from class: Collector

Called before successive calls to Collector.collect(int). Implementations that need the score of the current document (passed-in to Collector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.

Specified by:

setScorer in class Collector

Throws:

IOException

collect

public void collect(int doc)
             throws IOException

Description copied from class: Collector

Called once for every document matching a query, with the unbased document number.

Note: This is called in an inner search loop. For good search performance, implementations of this method should not call Searcher.doc(int) or IndexReader.document(int) on every hit. Doing so can slow searches by an order of magnitude or more.

Specified by:

collect in class Collector

Throws:

IOException

setNextReader

public void setNextReader(IndexReader reader,
                          int docBase)

Description copied from class: Collector

Called before collecting from each IndexReader. All doc ids in Collector.collect(int) will correspond to reader. Add docBase to the current IndexReaders internal document id to re-base ids in Collector.collect(int).

Specified by:

setNextReader in class Collector

Parameters:

reader - next IndexReader

acceptsDocsOutOfOrder

public boolean acceptsDocsOutOfOrder()

Description copied from class: Collector

Return true if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) to Collector.collect(int).

Most Lucene Query implementations will visit matching docIDs in order. However, some queries (currently limited to certain cases of BooleanQuery) can achieve faster searching if the Collector allows them to deliver the docIDs out of order.

Many collectors don't mind getting docIDs out of order, so it's important to return true here.

Specified by:

acceptsDocsOutOfOrder in class Collector