Uses of Class
org.apache.lucene.search.Explanation
Packages that use Explanation
Package
Description
The logical representation of a
Document
for indexing and
searching.Expressions.
Monitoring framework
Queries that compute score based upon a function.
Intervals queries
The payloads package provides Query mechanisms for finding and using payloads.
The calculus of spans.
This package contains a flexible graph-based proximity query, TermAutomatonQuery, and geospatial
queries.
Code to search indices.
Support for index-time and query-time joins.
This package contains the various ranking models that can be used in Lucene.
Support for document suggestion
-
Uses of Explanation in org.apache.lucene.document
Methods in org.apache.lucene.document that return ExplanationModifier and TypeMethodDescription(package private) abstract Explanation
(package private) Explanation
(package private) Explanation
(package private) Explanation
(package private) Explanation
-
Uses of Explanation in org.apache.lucene.expressions
Methods in org.apache.lucene.expressions that return ExplanationModifier and TypeMethodDescriptionExpressionRescorer.explain
(IndexSearcher searcher, Explanation firstPassExplanation, int docID) ExpressionValueSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) Methods in org.apache.lucene.expressions with parameters of type ExplanationModifier and TypeMethodDescriptionExpressionRescorer.explain
(IndexSearcher searcher, Explanation firstPassExplanation, int docID) ExpressionValueSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) -
Uses of Explanation in org.apache.lucene.monitor
Fields in org.apache.lucene.monitor declared as ExplanationMethods in org.apache.lucene.monitor that return ExplanationConstructors in org.apache.lucene.monitor with parameters of type ExplanationModifierConstructorDescription(package private)
ExplainingMatch
(String queryId, Explanation explanation) -
Uses of Explanation in org.apache.lucene.queries.function
Methods in org.apache.lucene.queries.function that return ExplanationModifier and TypeMethodDescriptionFunctionQuery.AllScorer.explain
(int doc) FunctionQuery.FunctionWeight.explain
(LeafReaderContext context, int doc) FunctionRangeQuery.FunctionRangeWeight.explain
(LeafReaderContext context, int doc) FunctionScoreQuery.FunctionScoreWeight.explain
(LeafReaderContext context, int doc) FunctionScoreQuery.MultiplicativeBoostValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) FunctionScoreQuery.QueryBoostValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) FunctionValues.explain
(int doc) ValueSource.WrappedDoubleValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) Methods in org.apache.lucene.queries.function with parameters of type ExplanationModifier and TypeMethodDescriptionFunctionScoreQuery.MultiplicativeBoostValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) FunctionScoreQuery.QueryBoostValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) ValueSource.WrappedDoubleValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) -
Uses of Explanation in org.apache.lucene.queries.intervals
Methods in org.apache.lucene.queries.intervals that return ExplanationModifier and TypeMethodDescriptionIntervalQuery.IntervalWeight.explain
(LeafReaderContext context, int doc) abstract Explanation
-
Uses of Explanation in org.apache.lucene.queries.payloads
Methods in org.apache.lucene.queries.payloads that return ExplanationModifier and TypeMethodDescriptionPayloadScoreQuery.PayloadSpanWeight.explain
(LeafReaderContext context, int doc) protected Explanation
PayloadScoreQuery.PayloadSpanScorer.getPayloadExplanation()
-
Uses of Explanation in org.apache.lucene.queries.spans
Methods in org.apache.lucene.queries.spans that return Explanation -
Uses of Explanation in org.apache.lucene.sandbox.search
Methods in org.apache.lucene.sandbox.search that return ExplanationModifier and TypeMethodDescriptionCombinedFieldQuery.CombinedFieldWeight.explain
(LeafReaderContext context, int doc) CoveringQuery.CoveringWeight.explain
(LeafReaderContext context, int doc) MultiNormsLeafSimScorer.explain
(int doc, Explanation freqExpl) Explain the score for the provided document assuming the given term document frequency.TermAutomatonQuery.TermAutomatonWeight.explain
(LeafReaderContext context, int doc) Methods in org.apache.lucene.sandbox.search with parameters of type ExplanationModifier and TypeMethodDescriptionMultiNormsLeafSimScorer.explain
(int doc, Explanation freqExpl) Explain the score for the provided document assuming the given term document frequency. -
Uses of Explanation in org.apache.lucene.search
Fields in org.apache.lucene.search with type parameters of type ExplanationMethods in org.apache.lucene.search that return ExplanationModifier and TypeMethodDescriptionBooleanWeight.explain
(LeafReaderContext context, int doc) ConstantScoreWeight.explain
(LeafReaderContext context, int doc) DisjunctionMaxQuery.DisjunctionMaxWeight.explain
(LeafReaderContext context, int doc) Explain the score we computed for docDoubleValuesSource.ConstantValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) DoubleValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) An explanation of the value for the named document.DoubleValuesSource.FieldValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) DoubleValuesSource.WeightDoubleValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) FilterWeight.explain
(LeafReaderContext context, int doc) Returns an Explanation that describes howdoc
scored againstquery
.protected Explanation
Expert: low-level implementation method Returns an Explanation that describes howdoc
scored againstweight
.IndriAndWeight.explain
(LeafReaderContext context, int doc) PhraseWeight.explain
(LeafReaderContext context, int doc) 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.SortRescorer.explain
(IndexSearcher searcher, Explanation firstPassExplanation, int docID) SynonymQuery.SynonymWeight.explain
(LeafReaderContext context, int doc) TermQuery.TermWeight.explain
(LeafReaderContext context, int doc) abstract Explanation
Weight.explain
(LeafReaderContext context, int doc) An explanation of the score computation for the named document.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 ExplanationModifier and TypeMethodDescriptionDoubleValuesSource.ConstantValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) DoubleValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) An explanation of the value for the named document.DoubleValuesSource.FieldValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) DoubleValuesSource.WeightDoubleValuesSource.explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) 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.SortRescorer.explain
(IndexSearcher searcher, Explanation firstPassExplanation, int docID) 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 ExplanationModifier and TypeMethodDescriptionstatic 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.Constructor parameters in org.apache.lucene.search with type arguments of type ExplanationModifierConstructorDescriptionprivate
Explanation
(boolean match, Number value, String description, Collection<Explanation> details) Create a new explanation -
Uses of Explanation in org.apache.lucene.search.join
Methods in org.apache.lucene.search.join that return ExplanationModifier and TypeMethodDescriptionGlobalOrdinalsQuery.W.explain
(LeafReaderContext context, int doc) GlobalOrdinalsWithScoreQuery.W.explain
(LeafReaderContext context, int doc) ToChildBlockJoinQuery.ToChildBlockJoinWeight.explain
(LeafReaderContext context, int doc) ToParentBlockJoinQuery.BlockJoinScorer.explain
(LeafReaderContext context, Weight childWeight, ScoreMode scoreMode) ToParentBlockJoinQuery.BlockJoinWeight.explain
(LeafReaderContext context, int doc) -
Uses of Explanation in org.apache.lucene.search.similarities
Fields in org.apache.lucene.search.similarities declared as ExplanationModifier and TypeFieldDescriptionprivate final Explanation
BM25Similarity.BM25Scorer.idf
BM25's idfprivate final Explanation
TFIDFSimilarity.TFIDFScorer.idf
The idf and its explanationMethods in org.apache.lucene.search.similarities that return ExplanationModifier and TypeMethodDescriptionabstract Explanation
AfterEffect.explain
(BasicStats stats, double tfn) Returns an explanation for the score.final Explanation
AfterEffectB.explain
(BasicStats stats, double tfn) final Explanation
AfterEffectL.explain
(BasicStats stats, double tfn) protected Explanation
Axiomatic.explain
(BasicStats stats, Explanation freq, double docLen) abstract Explanation
BasicModel.explain
(BasicStats stats, double tfn, double aeTimes1pTfn) Returns an explanation for the score.BasicModelG.explain
(BasicStats stats, double tfn, double aeTimes1pTfn) BasicModelIF.explain
(BasicStats stats, double tfn, double aeTimes1pTfn) final Explanation
BasicModelIn.explain
(BasicStats stats, double tfn, double aeTimes1pTfn) BasicModelIne.explain
(BasicStats stats, double tfn, double aeTimes1pTfn) BM25Similarity.BM25Scorer.explain
(Explanation freq, long encodedNorm) BooleanSimilarity.BooleanWeight.explain
(Explanation freq, long norm) protected Explanation
DFISimilarity.explain
(BasicStats stats, Explanation freq, double docLen) protected Explanation
DFRSimilarity.explain
(BasicStats stats, Explanation freq, double docLen) 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.final Explanation
LambdaDF.explain
(BasicStats stats) final 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) MultiSimilarity.MultiSimScorer.explain
(Explanation freq, long norm) Normalization.explain
(BasicStats stats, double tf, double len) Returns an explanation for the normalized term frequency.Normalization.NoNormalization.explain
(BasicStats stats, double tf, double len) NormalizationH1.explain
(BasicStats stats, double tf, double len) NormalizationH2.explain
(BasicStats stats, double tf, double len) NormalizationH3.explain
(BasicStats stats, double tf, double len) NormalizationZ.explain
(BasicStats stats, double tf, double len) Similarity.SimScorer.explain
(Explanation freq, long norm) Explain the score for a single documentSimilarityBase.BasicSimScorer.explain
(Explanation freq, long norm) protected Explanation
SimilarityBase.explain
(BasicStats stats, Explanation freq, double docLen) Explains the score.TFIDFSimilarity.TFIDFScorer.explain
(Explanation freq, long norm) private Explanation
TFIDFSimilarity.TFIDFScorer.explainScore
(Explanation freq, long encodedNorm, float[] normTable) private Explanation
BM25Similarity.BM25Scorer.explainTF
(Explanation freq, long norm) protected abstract Explanation
Axiomatic.idfExplain
(BasicStats stats, double freq, double docLen) Explain the score of the inverted document frequency component for a single documentprotected Explanation
AxiomaticF1EXP.idfExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF1LOG.idfExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF2EXP.idfExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF2LOG.idfExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF3EXP.idfExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF3LOG.idfExplain
(BasicStats stats, double freq, double docLen) BM25Similarity.idfExplain
(CollectionStatistics collectionStats, TermStatistics termStats) Computes a score factor for a simple term and returns an explanation for that score factor.BM25Similarity.idfExplain
(CollectionStatistics collectionStats, TermStatistics[] termStats) Computes a score factor for a phrase.ClassicSimilarity.idfExplain
(CollectionStatistics collectionStats, TermStatistics termStats) TFIDFSimilarity.idfExplain
(CollectionStatistics collectionStats, TermStatistics termStats) Computes a score factor for a simple term and returns an explanation for that score factor.TFIDFSimilarity.idfExplain
(CollectionStatistics collectionStats, TermStatistics[] termStats) Computes a score factor for a phrase.protected abstract Explanation
Axiomatic.lnExplain
(BasicStats stats, double freq, double docLen) Explain the score of the document length component for a single documentprotected Explanation
AxiomaticF1EXP.lnExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF1LOG.lnExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF2EXP.lnExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF2LOG.lnExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF3EXP.lnExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF3LOG.lnExplain
(BasicStats stats, double freq, double docLen) protected abstract Explanation
Axiomatic.tfExplain
(BasicStats stats, double freq, double docLen) Explain the score of the term frequency component for a single documentprotected Explanation
AxiomaticF1EXP.tfExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF1LOG.tfExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF2EXP.tfExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF2LOG.tfExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF3EXP.tfExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF3LOG.tfExplain
(BasicStats stats, double freq, double docLen) protected abstract Explanation
Axiomatic.tflnExplain
(BasicStats stats, double freq, double docLen) Explain the score of the mixed term frequency and document length component for a single documentprotected Explanation
AxiomaticF1EXP.tflnExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF1LOG.tflnExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF2EXP.tflnExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF2LOG.tflnExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF3EXP.tflnExplain
(BasicStats stats, double freq, double docLen) protected Explanation
AxiomaticF3LOG.tflnExplain
(BasicStats stats, double freq, double docLen) Methods in org.apache.lucene.search.similarities that return types with arguments of type ExplanationModifier and TypeMethodDescriptionprivate List
<Explanation> BM25Similarity.BM25Scorer.explainConstantFactors()
Methods in org.apache.lucene.search.similarities with parameters of type ExplanationModifier and TypeMethodDescriptionprotected Explanation
Axiomatic.explain
(BasicStats stats, Explanation freq, double docLen) BM25Similarity.BM25Scorer.explain
(Explanation freq, long encodedNorm) BooleanSimilarity.BooleanWeight.explain
(Explanation freq, long norm) 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) MultiSimilarity.MultiSimScorer.explain
(Explanation freq, long norm) Similarity.SimScorer.explain
(Explanation freq, long norm) Explain the score for a single documentSimilarityBase.BasicSimScorer.explain
(Explanation freq, long norm) protected Explanation
SimilarityBase.explain
(BasicStats stats, Explanation freq, double docLen) Explains the score.TFIDFSimilarity.TFIDFScorer.explain
(Explanation freq, long norm) private Explanation
TFIDFSimilarity.TFIDFScorer.explainScore
(Explanation freq, long encodedNorm, float[] normTable) private Explanation
BM25Similarity.BM25Scorer.explainTF
(Explanation freq, long norm) Method parameters in org.apache.lucene.search.similarities with type arguments of type ExplanationModifier and TypeMethodDescriptionprotected void
Axiomatic.explain
(List<Explanation> subs, BasicStats stats, double freq, double docLen) 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
IndriDirichletSimilarity.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.Constructors in org.apache.lucene.search.similarities with parameters of type ExplanationModifierConstructorDescription(package private)
BM25Scorer
(float boost, float k1, float b, Explanation idf, float avgdl, float[] cache) TFIDFScorer
(float boost, Explanation idf, float[] normTable) -
Uses of Explanation in org.apache.lucene.search.suggest.document
Methods in org.apache.lucene.search.suggest.document that return Explanation