Class ExplanationAsserter

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 Lucene.Net.Search.Query and Lucene.Net.Search.IndexSearcher specified at when it is constructed.
Inheritance
object
ExplanationAsserter
Implements
ICollector
Inherited Members
Namespace: Lucene.Net.Search
Assembly: Lucene.Net.TestFramework.dll
Syntax
public class ExplanationAsserter : ICollector

Constructors

ExplanationAsserter(Query, string, IndexSearcher)

Constructs an instance which does shallow tests on the Explanation

Declaration
public ExplanationAsserter(Query q, string defaultFieldName, IndexSearcher s)
Parameters
Type Name Description
Query q
string defaultFieldName
IndexSearcher s
See Also

ExplanationAsserter(Query, string, IndexSearcher, bool)

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 Lucene.Net.Search.Query and Lucene.Net.Search.IndexSearcher specified at when it is constructed.
Declaration
public ExplanationAsserter(Query q, string defaultFieldName, IndexSearcher s, bool deep)
Parameters
Type Name Description
Query q
string defaultFieldName
IndexSearcher s
bool deep
See Also

Properties

AcceptsDocsOutOfOrder

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

Most Lucene Query implementations will visit matching docIDs in order. However, some queries (currently limited to certain cases of Lucene.Net.Search.BooleanQuery) can achieve faster searching if the Lucene.Net.Search.ICollector 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.

Declaration
public virtual bool AcceptsDocsOutOfOrder { get; }
Property Value
Type Description
bool
See Also

Methods

Collect(int)

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

Note: The collection of the current segment can be terminated by throwing a Lucene.Net.Search.CollectionTerminatedException. In this case, the last docs of the current Lucene.Net.Index.AtomicReaderContext will be skipped and Lucene.Net.Search.IndexSearcher will swallow the exception and continue collection with the next leaf.

Note: this is called in an inner search loop. For good search performance, implementations of this method should not call Doc(int) or Document(int) on every hit. Doing so can slow searches by an order of magnitude or more.
Declaration
public virtual void Collect(int doc)
Parameters
Type Name Description
int doc
See Also

SetNextReader(AtomicReaderContext)

Called before collecting from each Lucene.Net.Index.AtomicReaderContext. All doc ids in Collect(int) will correspond to Lucene.Net.Index.IndexReaderContext.Reader.

Add Lucene.Net.Index.AtomicReaderContext.DocBase to the current Lucene.Net.Index.IndexReaderContext.Reader's internal document id to re-base ids in Collect(int).
Declaration
public virtual void SetNextReader(AtomicReaderContext context)
Parameters
Type Name Description
AtomicReaderContext context

next atomic reader context
See Also

SetScorer(Scorer)

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

Declaration
public virtual void SetScorer(Scorer scorer)
Parameters
Type Name Description
Scorer scorer
See Also

Implements

Lucene.Net.Search.ICollector

See Also