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

Packages that use Explanation

Package	Description
org.apache.lucene.search	Code to search indices.
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

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

Modifier and Type	Method and Description
Explanation	SortRescorer.explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)
abstract Explanation	Rescorer.explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID) Explains how the score for the specified document was computed.
Explanation	QueryRescorer.explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)
abstract Explanation	Weight.explain(LeafReaderContext context, int doc) An explanation of the score computation for the named document.
Explanation	FilterWeight.explain(LeafReaderContext context, int doc)
Explanation	DisjunctionMaxQuery.DisjunctionMaxWeight.explain(LeafReaderContext context, int doc) Explain the score we computed for doc
Explanation	ConstantScoreWeight.explain(LeafReaderContext context, int doc)
Explanation	DoubleValuesSource.explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation) An explanation of the value for the named document.
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.
static Explanation	Explanation.match(float value, String description, Collection<Explanation> details) Create a new explanation for a match.
static Explanation	Explanation.match(float value, String description, Explanation... details) Create a new explanation for a match.
static Explanation	Explanation.noMatch(String description, Collection<Explanation> details) Create a new explanation for a document which does not match.
static Explanation	Explanation.noMatch(String description, Explanation... details) Create a new explanation for a document which does not match.

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

Modifier and Type	Method and Description
Explanation	SortRescorer.explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)
abstract Explanation	Rescorer.explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID) Explains how the score for the specified document was computed.
Explanation	QueryRescorer.explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)
Explanation	DoubleValuesSource.explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation) An explanation of the value for the named document.
static Explanation	Explanation.match(float value, String description, Explanation... details) Create a new explanation for a match.
static Explanation	Explanation.noMatch(String description, Explanation... details) Create a new explanation for a document which does not match.

Method parameters in org.apache.lucene.search with type arguments of type Explanation

Modifier and Type	Method and Description
static Explanation	Explanation.match(float value, String description, Collection<Explanation> details) Create a new explanation for a match.
static Explanation	Explanation.noMatch(String description, Collection<Explanation> details) Create a new explanation for a document which does not match.

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

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

Modifier and Type	Method and Description
Explanation	LambdaTTF.explain(BasicStats stats)
Explanation	LambdaDF.explain(BasicStats stats)
abstract Explanation	Lambda.explain(BasicStats stats) Explains the lambda parameter.
Explanation	BasicModelIn.explain(BasicStats stats, float tfn)
Explanation	BasicModel.explain(BasicStats stats, float tfn) Returns an explanation for the score.
Explanation	AfterEffectL.explain(BasicStats stats, float tfn)
Explanation	AfterEffectB.explain(BasicStats stats, float tfn)
abstract Explanation	AfterEffect.explain(BasicStats stats, float tfn) Returns an explanation for the score.
Explanation	AfterEffect.NoAfterEffect.explain(BasicStats stats, float tfn)
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)
Explanation	Distribution.explain(BasicStats stats, float tfn, float lambda) Explains the score.
protected Explanation	SimilarityBase.explain(BasicStats stats, int doc, Explanation freq, float docLen) Explains the score.
Explanation	Similarity.SimScorer.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	ClassicSimilarity.idfExplain(CollectionStatistics collectionStats, TermStatistics termStats)
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

Modifier and Type	Method and Description
protected Explanation	SimilarityBase.explain(BasicStats stats, int doc, Explanation freq, float docLen) Explains the score.
Explanation	Similarity.SimScorer.explain(int doc, Explanation freq) Explain the score for a single document

Method parameters in org.apache.lucene.search.similarities with type arguments of type Explanation

Modifier and Type	Method and Description
protected void	SimilarityBase.explain(List<Explanation> subExpls, BasicStats stats, int doc, float freq, float docLen) Subclasses should implement this method to explain the score.
protected void	LMSimilarity.explain(List<Explanation> subExpls, BasicStats stats, int doc, float freq, float docLen)
protected void	LMJelinekMercerSimilarity.explain(List<Explanation> subs, BasicStats stats, int doc, float freq, float docLen)
protected void	LMDirichletSimilarity.explain(List<Explanation> subs, BasicStats stats, int doc, float freq, float docLen)
protected void	IBSimilarity.explain(List<Explanation> subs, BasicStats stats, int doc, float freq, float docLen)
protected void	DFRSimilarity.explain(List<Explanation> subs, BasicStats stats, int doc, float freq, float docLen)
protected void	Axiomatic.explain(List<Explanation> subs, BasicStats stats, int doc, float freq, float docLen)

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

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

Modifier and Type	Method and Description
Explanation	SpanWeight.explain(LeafReaderContext context, int doc)