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

Packages that use Explanation

Package	Description
org.apache.lucene.search
org.apache.lucene.search.similarities
org.apache.lucene.search.spans
org.apache.lucene.search.suggest.document
org.apache.lucene.spatial.util
org.elasticsearch.action.explain
org.elasticsearch.common.lucene
org.elasticsearch.common.lucene.search.function
org.elasticsearch.index.query.functionscore
org.elasticsearch.script
org.elasticsearch.search
org.elasticsearch.search.profile.query
org.elasticsearch.search.rescore

Uses of Explanation in org.apache.lucene.search

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

Modifier and Type	Method	Description
Explanation	ConstantScoreWeight.explain(LeafReaderContext context, int doc)
Explanation	DisjunctionMaxQuery.DisjunctionMaxWeight.explain(LeafReaderContext context, int doc)	Explain the score we computed for doc
Explanation	DoubleValuesSource.explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)	An explanation of the value for the named document.
Explanation	FilterWeight.explain(LeafReaderContext 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	LeafSimScorer.explain(int doc, Explanation freqExpl)	Explain the score for the provided document assuming the given term document frequency.
Explanation	QueryRescorer.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.
abstract Explanation	Weight.explain(LeafReaderContext context, int doc)	An explanation of the score computation for the named document.
Explanation[]	Explanation.getDetails()	The sub-nodes of this explanation node.
static Explanation	Explanation.match(Number value, String description, Collection<Explanation> details)	Create a new explanation for a match.
static Explanation	Explanation.match(Number 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	Description
Explanation	DoubleValuesSource.explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)	An explanation of the value for the named document.
Explanation	LeafSimScorer.explain(int doc, Explanation freqExpl)	Explain the score for the provided document assuming the given term document frequency.
Explanation	QueryRescorer.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.
static Explanation	Explanation.match(Number 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	Description
static Explanation	Explanation.match(Number 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	Description
abstract Explanation	AfterEffect.explain(BasicStats stats, double tfn)	Returns an explanation for the score.
Explanation	AfterEffectB.explain(BasicStats stats, double tfn)
Explanation	AfterEffectL.explain(BasicStats stats, double tfn)
abstract Explanation	BasicModel.explain(BasicStats stats, double tfn, double aeTimes1pTfn)	Returns an explanation for the score.
Explanation	BasicModelG.explain(BasicStats stats, double tfn, double aeTimes1pTfn)
Explanation	BasicModelIF.explain(BasicStats stats, double tfn, double aeTimes1pTfn)
Explanation	BasicModelIn.explain(BasicStats stats, double tfn, double aeTimes1pTfn)
Explanation	BasicModelIne.explain(BasicStats stats, double tfn, double aeTimes1pTfn)
protected Explanation	DFISimilarity.explain(BasicStats stats, Explanation freq, double docLen)
protected Explanation	DFRSimilarity.explain(BasicStats stats, Explanation freq, double docLen)
Explanation	Distribution.explain(BasicStats stats, double tfn, double lambda)	Explains the score.
protected Explanation	IBSimilarity.explain(BasicStats stats, Explanation freq, double docLen)
abstract Explanation	Lambda.explain(BasicStats stats)	Explains the lambda parameter.
Explanation	LambdaDF.explain(BasicStats stats)
Explanation	LambdaTTF.explain(BasicStats stats)
protected Explanation	LMDirichletSimilarity.explain(BasicStats stats, Explanation freq, double docLen)
protected Explanation	LMJelinekMercerSimilarity.explain(BasicStats stats, Explanation freq, double docLen)
Explanation	Normalization.explain(BasicStats stats, double tf, double len)	Returns an explanation for the normalized term frequency.
Explanation	Normalization.NoNormalization.explain(BasicStats stats, double tf, double len)
Explanation	NormalizationH1.explain(BasicStats stats, double tf, double len)
Explanation	NormalizationH2.explain(BasicStats stats, double tf, double len)
Explanation	NormalizationH3.explain(BasicStats stats, double tf, double len)
Explanation	NormalizationZ.explain(BasicStats stats, double tf, double len)
Explanation	Similarity.SimScorer.explain(Explanation freq, long norm)	Explain the score for a single document
protected Explanation	SimilarityBase.explain(BasicStats stats, Explanation freq, double docLen)	Explains the score.
Explanation	BM25Similarity.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 phrase.
Explanation	ClassicSimilarity.idfExplain(CollectionStatistics collectionStats, TermStatistics termStats)
Explanation	TFIDFSimilarity.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.

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

Modifier and Type	Method	Description
protected Explanation	DFISimilarity.explain(BasicStats stats, Explanation freq, double docLen)
protected Explanation	DFRSimilarity.explain(BasicStats stats, Explanation freq, double docLen)
protected Explanation	IBSimilarity.explain(BasicStats stats, Explanation freq, double docLen)
protected Explanation	LMDirichletSimilarity.explain(BasicStats stats, Explanation freq, double docLen)
protected Explanation	LMJelinekMercerSimilarity.explain(BasicStats stats, Explanation freq, double docLen)
Explanation	Similarity.SimScorer.explain(Explanation freq, long norm)	Explain the score for a single document
protected Explanation	SimilarityBase.explain(BasicStats stats, Explanation freq, double docLen)	Explains the score.

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

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

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

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

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

Uses of Explanation in org.apache.lucene.search.suggest.document

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

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

Uses of Explanation in org.apache.lucene.spatial.util

Methods in org.apache.lucene.spatial.util that return Explanation

Modifier and Type	Method	Description
Explanation	ReciprocalDoubleValuesSource.explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)

Methods in org.apache.lucene.spatial.util with parameters of type Explanation

Modifier and Type	Method	Description
Explanation	ReciprocalDoubleValuesSource.explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)

Uses of Explanation in org.elasticsearch.action.explain

Methods in org.elasticsearch.action.explain that return Explanation

Modifier and Type	Method	Description
Explanation	ExplainResponse.getExplanation()

Constructors in org.elasticsearch.action.explain with parameters of type Explanation

Constructor	Description
ExplainResponse(String index, String type, String id, boolean exists, Explanation explanation)
ExplainResponse(String index, String type, String id, boolean exists, Explanation explanation, GetResult getResult)

Uses of Explanation in org.elasticsearch.common.lucene

Methods in org.elasticsearch.common.lucene that return Explanation

Modifier and Type	Method	Description
static Explanation	Lucene.readExplanation(StreamInput in)

Methods in org.elasticsearch.common.lucene with parameters of type Explanation

Modifier and Type	Method	Description
static void	Lucene.writeExplanation(StreamOutput out, Explanation explanation)

Uses of Explanation in org.elasticsearch.common.lucene.search.function

Methods in org.elasticsearch.common.lucene.search.function that return Explanation

Modifier and Type	Method	Description
abstract Explanation	CombineFunction.explain(Explanation queryExpl, Explanation funcExpl, float maxBoost)
abstract Explanation	LeafScoreFunction.explainScore(int docId, Explanation subQueryScore)
Explanation	WeightFactorFunction.explainWeight()

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

Modifier and Type	Method	Description
abstract Explanation	CombineFunction.explain(Explanation queryExpl, Explanation funcExpl, float maxBoost)
abstract Explanation	LeafScoreFunction.explainScore(int docId, Explanation subQueryScore)

Uses of Explanation in org.elasticsearch.index.query.functionscore

Methods in org.elasticsearch.index.query.functionscore that return Explanation

Modifier and Type	Method	Description
Explanation	DecayFunction.explainFunction(String valueString, double value, double scale)

Uses of Explanation in org.elasticsearch.script

Methods in org.elasticsearch.script that return Explanation

Modifier and Type	Method	Description
Explanation	ExplainableScoreScript.explain(Explanation subQueryScore)	Build the explanation of the current document being scored The script score needs the Explanation of the sub query score because it might use _score and want to explain how that was computed.
Explanation	ScoreScript.ExplanationHolder.get(double score, Explanation subQueryExplanation)

Methods in org.elasticsearch.script with parameters of type Explanation

Modifier and Type	Method	Description
Explanation	ExplainableScoreScript.explain(Explanation subQueryScore)	Build the explanation of the current document being scored The script score needs the Explanation of the sub query score because it might use _score and want to explain how that was computed.
Explanation	ScoreScript.ExplanationHolder.get(double score, Explanation subQueryExplanation)

Uses of Explanation in org.elasticsearch.search

Methods in org.elasticsearch.search that return Explanation

Modifier and Type	Method	Description
Explanation	SearchHit.getExplanation()	If enabled, the explanation of the search hit.

Methods in org.elasticsearch.search with parameters of type Explanation

Modifier and Type	Method	Description
void	SearchHit.explanation(Explanation explanation)

Uses of Explanation in org.elasticsearch.search.profile.query

Methods in org.elasticsearch.search.profile.query that return Explanation

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

Uses of Explanation in org.elasticsearch.search.rescore

Methods in org.elasticsearch.search.rescore that return Explanation

Modifier and Type	Method	Description
Explanation	QueryRescorer.explain(int topLevelDocId, IndexSearcher searcher, RescoreContext rescoreContext, Explanation sourceExplanation)
Explanation	Rescorer.explain(int topLevelDocId, IndexSearcher searcher, RescoreContext rescoreContext, Explanation sourceExplanation)	Executes an Explanation phase on the rescorer.

Methods in org.elasticsearch.search.rescore with parameters of type Explanation

Modifier and Type	Method	Description
Explanation	QueryRescorer.explain(int topLevelDocId, IndexSearcher searcher, RescoreContext rescoreContext, Explanation sourceExplanation)
Explanation	Rescorer.explain(int topLevelDocId, IndexSearcher searcher, RescoreContext rescoreContext, Explanation sourceExplanation)	Executes an Explanation phase on the rescorer.