Uses of Class
org.apache.lucene.search.Explanation
Packages that use Explanation
Package
Description
Code to search indices.
This package contains the various ranking models that can be used in Lucene.
-
Uses of Explanation in org.apache.lucene.search
Methods in org.apache.lucene.search that return ExplanationModifier and TypeMethodDescriptionConstantScoreWeight.explain(LeafReaderContext context, int doc) DisjunctionMaxQuery.DisjunctionMaxWeight.explain(LeafReaderContext context, int doc) Explain the score we computed for docDoubleValuesSource.explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation) An explanation of the value for the named document.FilterWeight.explain(LeafReaderContext context, int doc) Returns an Explanation that describes howdocscored againstquery.protected ExplanationExpert: low-level implementation method Returns an Explanation that describes howdocscored againstweight.IndriAndWeight.explain(LeafReaderContext context, int doc) PhraseWeight.explain(LeafReaderContext context, int doc) QueryRescorer.explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID) abstract ExplanationRescorer.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) abstract ExplanationWeight.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 ExplanationExplanation.match(Number value, String description, Collection<Explanation> details) Create a new explanation for a match.static ExplanationExplanation.match(Number value, String description, Explanation... details) Create a new explanation for a match.static ExplanationExplanation.noMatch(String description, Collection<Explanation> details) Create a new explanation for a document which does not match.static ExplanationExplanation.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.explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation) An explanation of the value for the named document.QueryRescorer.explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID) abstract ExplanationRescorer.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 ExplanationExplanation.match(Number value, String description, Explanation... details) Create a new explanation for a match.static ExplanationExplanation.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 ExplanationExplanation.match(Number value, String description, Collection<Explanation> details) Create a new explanation for a match.static ExplanationExplanation.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 ExplanationModifier and TypeMethodDescriptionabstract ExplanationAfterEffect.explain(BasicStats stats, double tfn) Returns an explanation for the score.final ExplanationAfterEffectB.explain(BasicStats stats, double tfn) final ExplanationAfterEffectL.explain(BasicStats stats, double tfn) protected ExplanationAxiomatic.explain(BasicStats stats, Explanation freq, double docLen) abstract ExplanationBasicModel.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 ExplanationBasicModelIn.explain(BasicStats stats, double tfn, double aeTimes1pTfn) BasicModelIne.explain(BasicStats stats, double tfn, double aeTimes1pTfn) protected ExplanationDFISimilarity.explain(BasicStats stats, Explanation freq, double docLen) protected ExplanationDFRSimilarity.explain(BasicStats stats, Explanation freq, double docLen) Distribution.explain(BasicStats stats, double tfn, double lambda) Explains the score.protected ExplanationIBSimilarity.explain(BasicStats stats, Explanation freq, double docLen) abstract ExplanationLambda.explain(BasicStats stats) Explains the lambda parameter.final ExplanationLambdaDF.explain(BasicStats stats) final ExplanationLambdaTTF.explain(BasicStats stats) protected ExplanationLMDirichletSimilarity.explain(BasicStats stats, Explanation freq, double docLen) protected ExplanationLMJelinekMercerSimilarity.explain(BasicStats stats, Explanation freq, double docLen) 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 documentprotected ExplanationSimilarityBase.explain(BasicStats stats, Explanation freq, double docLen) Explains the score.protected abstract ExplanationAxiomatic.idfExplain(BasicStats stats, double freq, double docLen) Explain the score of the inverted document frequency component for a single documentprotected ExplanationAxiomaticF1EXP.idfExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF1LOG.idfExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF2EXP.idfExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF2LOG.idfExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF3EXP.idfExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF3LOG.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 ExplanationAxiomatic.lnExplain(BasicStats stats, double freq, double docLen) Explain the score of the document length component for a single documentprotected ExplanationAxiomaticF1EXP.lnExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF1LOG.lnExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF2EXP.lnExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF2LOG.lnExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF3EXP.lnExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF3LOG.lnExplain(BasicStats stats, double freq, double docLen) protected abstract ExplanationAxiomatic.tfExplain(BasicStats stats, double freq, double docLen) Explain the score of the term frequency component for a single documentprotected ExplanationAxiomaticF1EXP.tfExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF1LOG.tfExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF2EXP.tfExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF2LOG.tfExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF3EXP.tfExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF3LOG.tfExplain(BasicStats stats, double freq, double docLen) protected abstract ExplanationAxiomatic.tflnExplain(BasicStats stats, double freq, double docLen) Explain the score of the mixed term frequency and document length component for a single documentprotected ExplanationAxiomaticF1EXP.tflnExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF1LOG.tflnExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF2EXP.tflnExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF2LOG.tflnExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF3EXP.tflnExplain(BasicStats stats, double freq, double docLen) protected ExplanationAxiomaticF3LOG.tflnExplain(BasicStats stats, double freq, double docLen) Methods in org.apache.lucene.search.similarities with parameters of type ExplanationModifier and TypeMethodDescriptionprotected ExplanationAxiomatic.explain(BasicStats stats, Explanation freq, double docLen) protected ExplanationDFISimilarity.explain(BasicStats stats, Explanation freq, double docLen) protected ExplanationDFRSimilarity.explain(BasicStats stats, Explanation freq, double docLen) protected ExplanationIBSimilarity.explain(BasicStats stats, Explanation freq, double docLen) protected ExplanationLMDirichletSimilarity.explain(BasicStats stats, Explanation freq, double docLen) protected ExplanationLMJelinekMercerSimilarity.explain(BasicStats stats, Explanation freq, double docLen) Similarity.SimScorer.explain(Explanation freq, long norm) Explain the score for a single documentprotected ExplanationSimilarityBase.explain(BasicStats stats, Explanation freq, double docLen) Explains the score.Method parameters in org.apache.lucene.search.similarities with type arguments of type ExplanationModifier and TypeMethodDescriptionprotected voidAxiomatic.explain(List<Explanation> subs, BasicStats stats, double freq, double docLen) protected voidDFRSimilarity.explain(List<Explanation> subs, BasicStats stats, double freq, double docLen) protected voidIBSimilarity.explain(List<Explanation> subs, BasicStats stats, double freq, double docLen) protected voidIndriDirichletSimilarity.explain(List<Explanation> subs, BasicStats stats, double freq, double docLen) protected voidLMDirichletSimilarity.explain(List<Explanation> subs, BasicStats stats, double freq, double docLen) protected voidLMJelinekMercerSimilarity.explain(List<Explanation> subs, BasicStats stats, double freq, double docLen) protected voidLMSimilarity.explain(List<Explanation> subExpls, BasicStats stats, double freq, double docLen) protected voidSimilarityBase.explain(List<Explanation> subExpls, BasicStats stats, double freq, double docLen) Subclasses should implement this method to explain the score.