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

Packages that use Explanation
org.apache.lucene.search: Code to search indices.
org.apache.lucene.search.payloads: The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.similarities: This package contains the various ranking models that can be used in Lucene.
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(AtomicReaderContext context, int doc)`
`abstract Explanation` `Weight.explain(AtomicReaderContext context, int doc)` An explanation of the score computation for the named document.
`Explanation` `DisjunctionMaxQuery.DisjunctionMaxWeight.explain(AtomicReaderContext context, int doc)` Explain the score we computed for doc
`Explanation` `BooleanQuery.BooleanWeight.explain(AtomicReaderContext context, int doc)`
`Explanation` `IndexSearcher.explain(Query query, int doc)` Returns an Explanation that describes how `doc` scored against `query`.
`protected Explanation` `IndexSearcher.explain(Weight weight, int doc)` Expert: low-level implementation method Returns an Explanation that describes how `doc` scored against `weight`.
`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.

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

Methods in org.apache.lucene.search.payloads that return Explanation
`Explanation` `PayloadNearQuery.PayloadNearSpanWeight.explain(AtomicReaderContext context, int doc)`
`Explanation` `PayloadTermQuery.PayloadTermWeight.explain(AtomicReaderContext context, int doc)`
`Explanation` `PayloadFunction.explain(int docId, String field, int numPayloadsSeen, float payloadScore)`

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

Methods in org.apache.lucene.search.similarities that return Explanation
`abstract Explanation` `Lambda.explain(BasicStats stats)` Explains the lambda parameter.
`Explanation` `LambdaTTF.explain(BasicStats stats)`
`Explanation` `LambdaDF.explain(BasicStats stats)`
`abstract Explanation` `AfterEffect.explain(BasicStats stats, float tfn)` Returns an explanation for the score.
`Explanation` `AfterEffect.NoAfterEffect.explain(BasicStats stats, float tfn)`
`Explanation` `AfterEffectB.explain(BasicStats stats, float tfn)`
`Explanation` `AfterEffectL.explain(BasicStats stats, float tfn)`
`Explanation` `BasicModel.explain(BasicStats stats, float tfn)` Returns an explanation for the score.
`Explanation` `BasicModelIn.explain(BasicStats stats, float tfn)`
`Explanation` `Distribution.explain(BasicStats stats, float tfn, float lambda)` Explains the score.
`Explanation` `Normalization.explain(BasicStats stats, float tf, float len)` Returns an explanation for the normalized term frequency.
`Explanation` `Normalization.NoNormalization.explain(BasicStats stats, float tf, float len)`
`protected Explanation` `SimilarityBase.explain(BasicStats stats, int doc, Explanation freq, float docLen)` Explains the score.
`Explanation` `Similarity.ExactSimScorer.explain(int doc, Explanation freq)` Explain the score for a single document
`Explanation` `Similarity.SloppySimScorer.explain(int doc, Explanation freq)` Explain the score for a single document
`Explanation` `TFIDFSimilarity.idfExplain(CollectionStatistics collectionStats, TermStatistics termStats)` Computes a score factor for a simple term and returns an explanation for that score factor.
`Explanation` `BM25Similarity.idfExplain(CollectionStatistics collectionStats, TermStatistics termStats)` Computes a score factor for a simple term and returns an explanation for that score factor.
`Explanation` `TFIDFSimilarity.idfExplain(CollectionStatistics collectionStats, TermStatistics[] termStats)` Computes a score factor for a phrase.
`Explanation` `BM25Similarity.idfExplain(CollectionStatistics collectionStats, TermStatistics[] termStats)` Computes a score factor for a phrase.

Methods in org.apache.lucene.search.similarities with parameters of type Explanation
`protected Explanation` `SimilarityBase.explain(BasicStats stats, int doc, Explanation freq, float docLen)` Explains the score.
`protected void` `SimilarityBase.explain(Explanation expl, BasicStats stats, int doc, float freq, float docLen)` Subclasses should implement this method to explain the score.
`protected void` `LMDirichletSimilarity.explain(Explanation expl, BasicStats stats, int doc, float freq, float docLen)`
`protected void` `DFRSimilarity.explain(Explanation expl, BasicStats stats, int doc, float freq, float docLen)`
`protected void` `IBSimilarity.explain(Explanation expl, BasicStats stats, int doc, float freq, float docLen)`
`protected void` `LMSimilarity.explain(Explanation expl, BasicStats stats, int doc, float freq, float docLen)`
`protected void` `LMJelinekMercerSimilarity.explain(Explanation expl, BasicStats stats, int doc, float freq, float docLen)`
`Explanation` `Similarity.ExactSimScorer.explain(int doc, Explanation freq)` Explain the score for a single document
`Explanation` `Similarity.SloppySimScorer.explain(int doc, Explanation freq)` Explain the score for a single document

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

Methods in org.apache.lucene.search.spans that return Explanation
`Explanation` `SpanWeight.explain(AtomicReaderContext context, int doc)`

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.