Package | Description |
---|---|
org.apache.lucene.document |
The logical representation of a
Document for indexing and searching. |
org.apache.lucene.queries.function |
Queries that compute score based upon a function.
|
org.apache.lucene.queries.payloads |
The payloads package provides Query mechanisms for finding and using payloads.
|
org.apache.lucene.search |
Code to search indices.
|
org.apache.lucene.search.intervals |
Intervals queries
|
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.spans |
The calculus of spans.
|
Modifier and Type | Method and Description |
---|---|
(package private) abstract Explanation |
FeatureField.FeatureFunction.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) |
Modifier and Type | Method and Description |
---|---|
Explanation |
FunctionValues.explain(int doc) |
Explanation |
FunctionQuery.AllScorer.explain(int doc) |
Explanation |
FunctionRangeQuery.FunctionRangeWeight.explain(LeafReaderContext context,
int doc) |
Explanation |
FunctionScoreQuery.FunctionScoreWeight.explain(LeafReaderContext context,
int doc) |
Explanation |
FunctionQuery.FunctionWeight.explain(LeafReaderContext context,
int doc) |
Explanation |
ValueSource.WrappedDoubleValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
Explanation |
FunctionScoreQuery.MultiplicativeBoostValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
Explanation |
FunctionScoreQuery.QueryBoostValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
Modifier and Type | Method and Description |
---|---|
Explanation |
ValueSource.WrappedDoubleValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
Explanation |
FunctionScoreQuery.MultiplicativeBoostValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
Explanation |
FunctionScoreQuery.QueryBoostValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
Modifier and Type | Method and 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() |
Modifier and Type | Field and Description |
---|---|
private java.util.List<Explanation> |
Explanation.details |
Modifier and Type | Method and Description |
---|---|
Explanation |
SortRescorer.explain(IndexSearcher searcher,
Explanation firstPassExplanation,
int docID) |
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 |
MultiNormsLeafSimScorer.explain(int doc,
Explanation freqExpl)
Explain the score for the provided document assuming the given term document frequency.
|
Explanation |
LeafSimScorer.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) |
Explanation |
BM25FQuery.BM25FWeight.explain(LeafReaderContext context,
int doc) |
Explanation |
CoveringQuery.CoveringWeight.explain(LeafReaderContext context,
int doc) |
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 |
SynonymQuery.SynonymWeight.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 |
PhraseWeight.explain(LeafReaderContext context,
int doc) |
Explanation |
TermQuery.TermWeight.explain(LeafReaderContext context,
int doc) |
Explanation |
BooleanWeight.explain(LeafReaderContext context,
int doc) |
Explanation |
DoubleValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation)
An explanation of the value for the named document.
|
Explanation |
DoubleValuesSource.ConstantValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
Explanation |
DoubleValuesSource.FieldValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
Explanation |
DoubleValuesSource.WeightDoubleValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
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(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.
|
Modifier and Type | Method and Description |
---|---|
Explanation |
SortRescorer.explain(IndexSearcher searcher,
Explanation firstPassExplanation,
int docID) |
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 |
MultiNormsLeafSimScorer.explain(int doc,
Explanation freqExpl)
Explain the score for the provided document assuming the given term document frequency.
|
Explanation |
LeafSimScorer.explain(int doc,
Explanation freqExpl)
Explain the score for the provided document assuming the given term document frequency.
|
Explanation |
DoubleValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation)
An explanation of the value for the named document.
|
Explanation |
DoubleValuesSource.ConstantValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
Explanation |
DoubleValuesSource.FieldValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
Explanation |
DoubleValuesSource.WeightDoubleValuesSource.explain(LeafReaderContext ctx,
int docId,
Explanation scoreExplanation) |
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.
|
Modifier and Type | Method and 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 and Description |
---|
Explanation(boolean match,
java.lang.Number value,
java.lang.String description,
java.util.Collection<Explanation> details)
Create a new explanation
|
Modifier and Type | Method and 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) |
Modifier and Type | Method and Description |
---|---|
Explanation |
GlobalOrdinalsQuery.W.explain(LeafReaderContext context,
int doc) |
Explanation |
ToParentBlockJoinQuery.BlockJoinWeight.explain(LeafReaderContext context,
int doc) |
Explanation |
ToChildBlockJoinQuery.ToChildBlockJoinWeight.explain(LeafReaderContext context,
int doc) |
Explanation |
GlobalOrdinalsWithScoreQuery.W.explain(LeafReaderContext context,
int doc) |
Explanation |
ToParentBlockJoinQuery.BlockJoinScorer.explain(LeafReaderContext context,
Weight childWeight) |
Modifier and Type | Field and Description |
---|---|
private Explanation |
TFIDFSimilarity.TFIDFScorer.idf
The idf and its explanation
|
private Explanation |
BM25Similarity.BM25Scorer.idf
BM25's idf
|
Modifier and Type | Method and Description |
---|---|
abstract Explanation |
Lambda.explain(BasicStats stats)
Explains the lambda parameter.
|
Explanation |
LambdaTTF.explain(BasicStats stats) |
Explanation |
LambdaDF.explain(BasicStats stats) |
Explanation |
AfterEffectB.explain(BasicStats stats,
double tfn) |
Explanation |
AfterEffectL.explain(BasicStats stats,
double tfn) |
abstract Explanation |
AfterEffect.explain(BasicStats stats,
double tfn)
Returns an explanation for the score.
|
Explanation |
NormalizationH3.explain(BasicStats stats,
double tf,
double len) |
abstract Explanation |
BasicModel.explain(BasicStats stats,
double tfn,
double aeTimes1pTfn)
Returns an explanation for the score.
|
Explanation |
Distribution.explain(BasicStats stats,
double tfn,
double lambda)
Explains the score.
|
Explanation |
NormalizationH1.explain(BasicStats stats,
double tf,
double len) |
Explanation |
NormalizationZ.explain(BasicStats stats,
double tf,
double len) |
Explanation |
BasicModelIn.explain(BasicStats stats,
double tfn,
double aeTimes1pTfn) |
Explanation |
BasicModelIF.explain(BasicStats stats,
double tfn,
double aeTimes1pTfn) |
Explanation |
BasicModelIne.explain(BasicStats stats,
double tfn,
double aeTimes1pTfn) |
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 |
BasicModelG.explain(BasicStats stats,
double tfn,
double aeTimes1pTfn) |
Explanation |
NormalizationH2.explain(BasicStats stats,
double tf,
double len) |
protected Explanation |
IBSimilarity.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
DFISimilarity.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
Axiomatic.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
LMJelinekMercerSimilarity.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
LMDirichletSimilarity.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
DFRSimilarity.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
SimilarityBase.explain(BasicStats stats,
Explanation freq,
double docLen)
Explains the score.
|
Explanation |
BooleanSimilarity.BooleanWeight.explain(Explanation freq,
long norm) |
Explanation |
TFIDFSimilarity.TFIDFScorer.explain(Explanation freq,
long norm) |
Explanation |
Similarity.SimScorer.explain(Explanation freq,
long norm)
Explain the score for a single document
|
Explanation |
BM25Similarity.BM25Scorer.explain(Explanation freq,
long encodedNorm) |
Explanation |
MultiSimilarity.MultiSimScorer.explain(Explanation freq,
long norm) |
Explanation |
SimilarityBase.BasicSimScorer.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 Explanation |
AxiomaticF2LOG.idfExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF1LOG.idfExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF3EXP.idfExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF1EXP.idfExplain(BasicStats stats,
double freq,
double docLen) |
protected abstract Explanation |
Axiomatic.idfExplain(BasicStats stats,
double freq,
double docLen)
Explain the score of the inverted document frequency component
for a single document
|
protected Explanation |
AxiomaticF2EXP.idfExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF3LOG.idfExplain(BasicStats stats,
double freq,
double docLen) |
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 |
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.
|
protected Explanation |
AxiomaticF2LOG.lnExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF1LOG.lnExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF3EXP.lnExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF1EXP.lnExplain(BasicStats stats,
double freq,
double docLen) |
protected abstract Explanation |
Axiomatic.lnExplain(BasicStats stats,
double freq,
double docLen)
Explain the score of the document length component for a single document
|
protected Explanation |
AxiomaticF2EXP.lnExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF3LOG.lnExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF2LOG.tfExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF1LOG.tfExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF3EXP.tfExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF1EXP.tfExplain(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 document
|
protected Explanation |
AxiomaticF2EXP.tfExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF3LOG.tfExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF2LOG.tflnExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF1LOG.tflnExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF3EXP.tflnExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF1EXP.tflnExplain(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 document
|
protected Explanation |
AxiomaticF2EXP.tflnExplain(BasicStats stats,
double freq,
double docLen) |
protected Explanation |
AxiomaticF3LOG.tflnExplain(BasicStats stats,
double freq,
double docLen) |
Modifier and Type | Method and Description |
---|---|
private java.util.List<Explanation> |
BM25Similarity.BM25Scorer.explainConstantFactors() |
Modifier and Type | Method and Description |
---|---|
protected Explanation |
IBSimilarity.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
DFISimilarity.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
Axiomatic.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
LMJelinekMercerSimilarity.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
LMDirichletSimilarity.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
DFRSimilarity.explain(BasicStats stats,
Explanation freq,
double docLen) |
protected Explanation |
SimilarityBase.explain(BasicStats stats,
Explanation freq,
double docLen)
Explains the score.
|
Explanation |
BooleanSimilarity.BooleanWeight.explain(Explanation freq,
long norm) |
Explanation |
TFIDFSimilarity.TFIDFScorer.explain(Explanation freq,
long norm) |
Explanation |
Similarity.SimScorer.explain(Explanation freq,
long norm)
Explain the score for a single document
|
Explanation |
BM25Similarity.BM25Scorer.explain(Explanation freq,
long encodedNorm) |
Explanation |
MultiSimilarity.MultiSimScorer.explain(Explanation freq,
long norm) |
Explanation |
SimilarityBase.BasicSimScorer.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) |
Modifier and Type | Method and Description |
---|---|
protected void |
IBSimilarity.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 |
Axiomatic.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 |
LMDirichletSimilarity.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 |
SimilarityBase.explain(java.util.List<Explanation> subExpls,
BasicStats stats,
double freq,
double docLen)
Subclasses should implement this method to explain the score.
|
Constructor and Description |
---|
BM25Scorer(float boost,
float k1,
float b,
Explanation idf,
float avgdl,
float[] cache) |
TFIDFScorer(float boost,
Explanation idf,
float[] normTable) |
Modifier and Type | Method and Description |
---|---|
Explanation |
SpanWeight.explain(LeafReaderContext context,
int doc) |