Uses of Class
org.apache.lucene.search.Explanation

Packages that use Explanation

org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.function	Programmatic control over documents scores.
org.apache.lucene.search.payloads	The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.spans	The calculus of spans.

Uses of Explanation in org.apache.lucene.search

Subclasses of Explanation in org.apache.lucene.search

class

ComplexExplanation Expert: Describes the score computation for document and query, and can distinguish a match independent of a positive value.

Methods in org.apache.lucene.search that return Explanation

Explanation	ConstantScoreQuery.ConstantWeight.explain(IndexReader reader, int doc)
Explanation	DisjunctionMaxQuery.DisjunctionMaxWeight.explain(IndexReader reader, int doc) Explain the score we computed for doc
Explanation	BooleanQuery.BooleanWeight.explain(IndexReader reader, int doc)
abstract Explanation	Weight.explain(IndexReader reader, int doc) An explanation of the score computation for the named document.
Explanation	IndexSearcher.explain(Query query, int doc) Returns an Explanation that describes how doc scored against query.
Explanation	Searcher.explain(Query query, int doc) Deprecated. Returns an Explanation that describes how doc scored against query.
Explanation	RemoteSearchable.explain(Weight weight, int doc) Deprecated.
Explanation	IndexSearcher.explain(Weight weight, int doc) Expert: low-level implementation method Returns an Explanation that describes how doc scored against weight.
abstract Explanation	Searcher.explain(Weight weight, int doc) Deprecated.
Explanation	Searchable.explain(Weight weight, int doc) Deprecated. Expert: low-level implementation method Returns an Explanation that describes how doc scored against weight.
Explanation	MultiSearcher.explain(Weight weight, int doc) Deprecated.
Explanation[]	Explanation.getDetails() The sub-nodes of this explanation node.

Methods in org.apache.lucene.search with parameters of type Explanation

void	Explanation.addDetail(Explanation detail) Adds a sub-node to this explanation node.
static void	CheckHits.verifyExplanation(String q, int doc, float score, boolean deep, Explanation expl) Assert that an explanation has the expected score, and optionally that its sub-details max/sum/factor match to that score.

Uses of Explanation in org.apache.lucene.search.function

Methods in org.apache.lucene.search.function that return Explanation

Explanation	CustomScoreProvider.customExplain(int doc, Explanation subQueryExpl, Explanation valSrcExpl) Explain the custom score.
Explanation	CustomScoreProvider.customExplain(int doc, Explanation subQueryExpl, Explanation[] valSrcExpls) Explain the custom score.
Explanation	DocValues.explain(int doc) Explain the scoring value for the input doc.

Methods in org.apache.lucene.search.function with parameters of type Explanation

Explanation	CustomScoreProvider.customExplain(int doc, Explanation subQueryExpl, Explanation valSrcExpl) Explain the custom score.
Explanation	CustomScoreProvider.customExplain(int doc, Explanation subQueryExpl, Explanation[] valSrcExpls) Explain the custom score.
Explanation	CustomScoreProvider.customExplain(int doc, Explanation subQueryExpl, Explanation[] valSrcExpls) Explain the custom score.

Uses of Explanation in org.apache.lucene.search.payloads

Methods in org.apache.lucene.search.payloads that return Explanation

Explanation	PayloadTermQuery.PayloadTermWeight.explain(IndexReader reader, int doc)
protected Explanation	PayloadNearQuery.PayloadNearSpanScorer.explain(int doc)
protected Explanation	PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer.explain(int doc)
Explanation	MaxPayloadFunction.explain(int doc, int numPayloadsSeen, float payloadScore)
Explanation	MinPayloadFunction.explain(int doc, int numPayloadsSeen, float payloadScore)
Explanation	AveragePayloadFunction.explain(int doc, int numPayloadsSeen, float payloadScore)
Explanation	PayloadFunction.explain(int docId, int numPayloadsSeen, float payloadScore)

Uses of Explanation in org.apache.lucene.search.spans

Methods in org.apache.lucene.search.spans that return Explanation

Explanation	SpanWeight.explain(IndexReader reader, int doc)
protected Explanation	SpanScorer.explain(int doc) This method is no longer an official member of Scorer, but it is needed by SpanWeight to build an explanation.