Class PerFieldSimilarityWrapper
java.lang.Object
org.apache.lucene.search.similarities.Similarity
org.apache.lucene.search.similarities.PerFieldSimilarityWrapper
Provides the ability to use a different
Similarity
for different fields.
Subclasses should implement get(String)
to return an appropriate Similarity (for
example, using field-specific parameter values) for the field.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.search.similarities.Similarity
Similarity.SimScorer
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal long
computeNorm
(FieldInvertState state) Computes the normalization value for a field, given the accumulated state of term processing for this field (seeFieldInvertState
).abstract Similarity
Returns aSimilarity
for scoring a field.final Similarity.SimScorer
scorer
(float boost, CollectionStatistics collectionStats, TermStatistics... termStats) Compute any collection-level weight (e.g.
-
Constructor Details
-
PerFieldSimilarityWrapper
public PerFieldSimilarityWrapper()Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Details
-
computeNorm
Description copied from class:Similarity
Computes the normalization value for a field, given the accumulated state of term processing for this field (seeFieldInvertState
).Matches in longer fields are less precise, so implementations of this method usually set smaller values when
state.getLength()
is large, and larger values whenstate.getLength()
is small.Note that for a given term-document frequency, greater unsigned norms must produce scores that are lower or equal, ie. for two encoded norms
n1
andn2
so thatLong.compareUnsigned(n1, n2) > 0
thenSimScorer.score(freq, n1) <= SimScorer.score(freq, n2)
for any legalfreq
.0
is not a legal norm, so1
is the norm that produces the highest scores.- Specified by:
computeNorm
in classSimilarity
- Parameters:
state
- current processing state for this field- Returns:
- computed norm value
-
scorer
public final Similarity.SimScorer scorer(float boost, CollectionStatistics collectionStats, TermStatistics... termStats) Description copied from class:Similarity
Compute any collection-level weight (e.g. IDF, average document length, etc) needed for scoring a query.- Specified by:
scorer
in classSimilarity
- Parameters:
boost
- a multiplicative factor to apply to the produces scorescollectionStats
- collection-level statistics, such as the number of tokens in the collection.termStats
- term-level statistics, such as the document frequency of a term across the collection.- Returns:
- SimWeight object with the information this Similarity needs to score a query.
-
get
Returns aSimilarity
for scoring a field.
-