Package 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.
-
-
Field Summary
Fields Modifier and Type Field Description static float
SCORE_TOLERANCE_DELTA
Deprecated.
-
Constructor Summary
Constructors Constructor Description ExplanationAsserter(Query q, String defaultFieldName, Searcher s)
Constructs an instance which does shallow tests on the ExplanationExplanationAsserter(Query q, String defaultFieldName, Searcher s, boolean deep)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
acceptsDocsOutOfOrder()
Returntrue
if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) toCollector.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 toCollector.collect(int)
.
-
-
-
Field Detail
-
SCORE_TOLERANCE_DELTA
@Deprecated public static float SCORE_TOLERANCE_DELTA
Deprecated.- See Also:
CheckHits.EXPLAIN_SCORE_TOLERANCE_DELTA
-
-
Method Detail
-
setScorer
public void setScorer(Scorer scorer) throws IOException
Description copied from class:Collector
Called before successive calls toCollector.collect(int)
. Implementations that need the score of the current document (passed-in toCollector.collect(int)
), should save the passed-in Scorer and call scorer.score() when needed.- Specified by:
setScorer
in classCollector
- 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)
orIndexReader.document(int)
on every hit. Doing so can slow searches by an order of magnitude or more.- Specified by:
collect
in classCollector
- Throws:
IOException
-
setNextReader
public void setNextReader(IndexReader reader, int docBase)
Description copied from class:Collector
Called before collecting from each IndexReader. All doc ids inCollector.collect(int)
will correspond to reader. Add docBase to the current IndexReaders internal document id to re-base ids inCollector.collect(int)
.- Specified by:
setNextReader
in classCollector
- Parameters:
reader
- next IndexReader
-
acceptsDocsOutOfOrder
public boolean acceptsDocsOutOfOrder()
Description copied from class:Collector
Returntrue
if this collector does not require the matching docIDs to be delivered in int sort order (smallest to largest) toCollector.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 theCollector
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 classCollector
-
-