Uses of Class
org.apache.lucene.search.Explanation
-
Packages that use Explanation Package Description org.apache.lucene.document The logical representation of aDocument
for indexing and searching.org.apache.lucene.expressions Expressions.org.apache.lucene.monitor Monitoring frameworkorg.apache.lucene.queries.function Queries that compute score based upon a function.org.apache.lucene.queries.intervals Intervals queriesorg.apache.lucene.queries.payloads The payloads package provides Query mechanisms for finding and using payloads.org.apache.lucene.queries.spans The calculus of spans.org.apache.lucene.sandbox.search This package contains a flexible graph-based proximity query, TermAutomatonQuery, and geospatial queries.org.apache.lucene.search Code to search indices.org.apache.lucene.search.join Support for index-time and query-time joins.org.apache.lucene.search.similarities This package contains the various ranking models that can be used in Lucene.org.apache.lucene.search.suggest.document Support for document suggestion -
-
Uses of Explanation in org.apache.lucene.document
Methods in org.apache.lucene.document that return Explanation Modifier and Type Method Description (package private) abstract Explanation
FeatureField.FeatureFunction. explain(java.lang.String field, java.lang.String feature, float w, int freq)
(package private) Explanation
FeatureField.LinearFunction. explain(java.lang.String field, java.lang.String feature, float w, int freq)
(package private) Explanation
FeatureField.LogFunction. explain(java.lang.String field, java.lang.String feature, float w, int freq)
(package private) Explanation
FeatureField.SaturationFunction. explain(java.lang.String field, java.lang.String feature, float weight, int freq)
(package private) Explanation
FeatureField.SigmoidFunction. explain(java.lang.String field, java.lang.String feature, float weight, int freq)
-
Uses of Explanation in org.apache.lucene.expressions
Methods in org.apache.lucene.expressions that return Explanation Modifier and Type Method Description Explanation
ExpressionRescorer. explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)
Explanation
ExpressionValueSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Methods in org.apache.lucene.expressions with parameters of type Explanation Modifier and Type Method Description Explanation
ExpressionRescorer. explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)
Explanation
ExpressionValueSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
-
Uses of Explanation in org.apache.lucene.monitor
Fields in org.apache.lucene.monitor declared as Explanation Modifier and Type Field Description private Explanation
ExplainingMatch. explanation
Methods in org.apache.lucene.monitor that return Explanation Modifier and Type Method Description Explanation
ExplainingMatch. getExplanation()
Constructors in org.apache.lucene.monitor with parameters of type Explanation Constructor Description ExplainingMatch(java.lang.String queryId, Explanation explanation)
-
Uses of Explanation in org.apache.lucene.queries.function
Methods in org.apache.lucene.queries.function that return Explanation Modifier and Type Method Description Explanation
FunctionQuery.AllScorer. explain(int doc)
Explanation
FunctionQuery.FunctionWeight. explain(LeafReaderContext context, int doc)
Explanation
FunctionRangeQuery.FunctionRangeWeight. explain(LeafReaderContext context, int doc)
Explanation
FunctionScoreQuery.FunctionScoreWeight. explain(LeafReaderContext context, int doc)
Explanation
FunctionScoreQuery.MultiplicativeBoostValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Explanation
FunctionScoreQuery.QueryBoostValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Explanation
FunctionValues. explain(int doc)
Explanation
ValueSource.WrappedDoubleValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Methods in org.apache.lucene.queries.function with parameters of type Explanation Modifier and Type Method Description Explanation
FunctionScoreQuery.MultiplicativeBoostValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Explanation
FunctionScoreQuery.QueryBoostValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Explanation
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 Explanation Modifier and Type Method Description Explanation
IntervalQuery.IntervalWeight. explain(LeafReaderContext context, int doc)
abstract Explanation
IntervalScoreFunction. explain(java.lang.String interval, float weight, float sloppyFreq)
Explanation
IntervalScoreFunction.SaturationFunction. explain(java.lang.String interval, float weight, float sloppyFreq)
Explanation
IntervalScoreFunction.SigmoidFunction. explain(java.lang.String interval, float weight, float sloppyFreq)
-
Uses of Explanation in org.apache.lucene.queries.payloads
Methods in org.apache.lucene.queries.payloads that return Explanation Modifier and Type Method Description Explanation
PayloadFunction. explain(int docId, java.lang.String field, int numPayloadsSeen, float payloadScore)
Explanation
PayloadScoreQuery.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 Modifier and Type Method Description Explanation
SpanWeight. explain(LeafReaderContext context, int doc)
-
Uses of Explanation in org.apache.lucene.sandbox.search
Methods in org.apache.lucene.sandbox.search that return Explanation Modifier and Type Method Description Explanation
CombinedFieldQuery.CombinedFieldWeight. explain(LeafReaderContext context, int doc)
Explanation
CoveringQuery.CoveringWeight. explain(LeafReaderContext context, int doc)
Explanation
MultiNormsLeafSimScorer. explain(int doc, Explanation freqExpl)
Explain the score for the provided document assuming the given term document frequency.Explanation
TermAutomatonQuery.TermAutomatonWeight. explain(LeafReaderContext context, int doc)
Methods in org.apache.lucene.sandbox.search with parameters of type Explanation Modifier and Type Method Description Explanation
MultiNormsLeafSimScorer. 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 Explanation Modifier and Type Field Description private java.util.List<Explanation>
Explanation. details
Methods in org.apache.lucene.search that return Explanation Modifier and Type Method Description Explanation
BooleanWeight. explain(LeafReaderContext context, int doc)
Explanation
ConstantScoreWeight. explain(LeafReaderContext context, int doc)
Explanation
DisjunctionMaxQuery.DisjunctionMaxWeight. explain(LeafReaderContext context, int doc)
Explain the score we computed for docExplanation
DoubleValuesSource.ConstantValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Explanation
DoubleValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
An explanation of the value for the named document.Explanation
DoubleValuesSource.FieldValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Explanation
DoubleValuesSource.WeightDoubleValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Explanation
FilterWeight. explain(LeafReaderContext context, int doc)
Explanation
IndexSearcher. explain(Query query, int doc)
Returns an Explanation that describes howdoc
scored againstquery
.protected Explanation
IndexSearcher. explain(Weight weight, int doc)
Expert: low-level implementation method Returns an Explanation that describes howdoc
scored againstweight
.Explanation
IndriAndWeight. explain(LeafReaderContext context, int doc)
Explanation
LeafSimScorer. explain(int doc, Explanation freqExpl)
Explain the score for the provided document assuming the given term document frequency.Explanation
PhraseWeight. explain(LeafReaderContext context, int doc)
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.Explanation
SortRescorer. explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)
Explanation
SynonymQuery.SynonymWeight. explain(LeafReaderContext context, int doc)
Explanation
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[]
Explanation. getDetails()
The sub-nodes of this explanation node.static Explanation
Explanation. match(java.lang.Number value, java.lang.String description, java.util.Collection<Explanation> details)
Create a new explanation for a match.static Explanation
Explanation. match(java.lang.Number value, java.lang.String description, Explanation... details)
Create a new explanation for a match.static Explanation
Explanation. noMatch(java.lang.String description, java.util.Collection<Explanation> details)
Create a new explanation for a document which does not match.static Explanation
Explanation. noMatch(java.lang.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.ConstantValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Explanation
DoubleValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
An explanation of the value for the named document.Explanation
DoubleValuesSource.FieldValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
Explanation
DoubleValuesSource.WeightDoubleValuesSource. explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation)
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.Explanation
SortRescorer. explain(IndexSearcher searcher, Explanation firstPassExplanation, int docID)
static Explanation
Explanation. match(java.lang.Number value, java.lang.String description, Explanation... details)
Create a new explanation for a match.static Explanation
Explanation. noMatch(java.lang.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(java.lang.Number value, java.lang.String description, java.util.Collection<Explanation> details)
Create a new explanation for a match.static Explanation
Explanation. noMatch(java.lang.String description, java.util.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 Explanation Constructor Description Explanation(boolean match, java.lang.Number value, java.lang.String description, java.util.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 Explanation Modifier and Type Method Description Explanation
GlobalOrdinalsQuery.W. explain(LeafReaderContext context, int doc)
Explanation
GlobalOrdinalsWithScoreQuery.W. explain(LeafReaderContext context, int doc)
Explanation
ToChildBlockJoinQuery.ToChildBlockJoinWeight. explain(LeafReaderContext context, int doc)
Explanation
ToParentBlockJoinQuery.BlockJoinScorer. explain(LeafReaderContext context, Weight childWeight, ScoreMode scoreMode)
Explanation
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 Explanation Modifier and Type Field Description private Explanation
BM25Similarity.BM25Scorer. idf
BM25's idfprivate Explanation
TFIDFSimilarity.TFIDFScorer. idf
The idf and its explanationMethods 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)
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.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)
Explanation
BM25Similarity.BM25Scorer. explain(Explanation freq, long encodedNorm)
Explanation
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)
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
MultiSimilarity.MultiSimScorer. explain(Explanation freq, long norm)
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 documentExplanation
SimilarityBase.BasicSimScorer. explain(Explanation freq, long norm)
protected Explanation
SimilarityBase. explain(BasicStats stats, Explanation freq, double docLen)
Explains the score.Explanation
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)
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.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 Explanation Modifier and Type Method Description private java.util.List<Explanation>
BM25Similarity.BM25Scorer. explainConstantFactors()
Methods in org.apache.lucene.search.similarities with parameters of type Explanation Modifier and Type Method Description protected Explanation
Axiomatic. explain(BasicStats stats, Explanation freq, double docLen)
Explanation
BM25Similarity.BM25Scorer. explain(Explanation freq, long encodedNorm)
Explanation
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)
Explanation
MultiSimilarity.MultiSimScorer. explain(Explanation freq, long norm)
Explanation
Similarity.SimScorer. explain(Explanation freq, long norm)
Explain the score for a single documentExplanation
SimilarityBase.BasicSimScorer. explain(Explanation freq, long norm)
protected Explanation
SimilarityBase. explain(BasicStats stats, Explanation freq, double docLen)
Explains the score.Explanation
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 Explanation Modifier and Type Method Description protected void
Axiomatic. explain(java.util.List<Explanation> subs, BasicStats stats, double freq, double docLen)
protected void
DFRSimilarity. explain(java.util.List<Explanation> subs, BasicStats stats, double freq, double docLen)
protected void
IBSimilarity. explain(java.util.List<Explanation> subs, BasicStats stats, double freq, double docLen)
protected void
IndriDirichletSimilarity. explain(java.util.List<Explanation> subs, BasicStats stats, double freq, double docLen)
protected void
LMDirichletSimilarity. explain(java.util.List<Explanation> subs, BasicStats stats, double freq, double docLen)
protected void
LMJelinekMercerSimilarity. explain(java.util.List<Explanation> subs, BasicStats stats, double freq, double docLen)
protected void
LMSimilarity. explain(java.util.List<Explanation> subExpls, BasicStats stats, double freq, double docLen)
protected void
SimilarityBase. explain(java.util.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 Explanation Constructor Description 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 Modifier and Type Method Description Explanation
CompletionWeight. explain(LeafReaderContext context, int doc)
-