java.lang.Object | ||
↳ | org.apache.lucene.search.Similarity | |
↳ | org.apache.lucene.search.SimilarityDelegator |
This class is deprecated.
this class will be removed in 4.0. Please
subclass Similarity
or DefaultSimilarity
instead.
Expert: Delegating scoring implementation. Useful in getSimilarity(Searcher)
implementations, to override only certain
methods of a Searcher's Similarity implementation..
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.lucene.search.Similarity
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Construct a
Similarity that delegates all methods to another. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Computes the normalization value for a field, given the accumulated
state of term processing for this field (see
FieldInvertState ). | |||||||||||
Computes a score factor based on the fraction of all query terms that a
document contains.
| |||||||||||
Computes a score factor based on a term's document frequency (the number
of documents which contain the term).
| |||||||||||
Computes the normalization value for a query given the sum of the squared
weights of each of the query terms.
| |||||||||||
Calculate a scoring factor based on the data in the payload.
| |||||||||||
Computes the amount of a sloppy phrase match, based on an edit distance.
| |||||||||||
Computes a score factor based on a term or phrase's frequency in a
document.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.lucene.search.Similarity
| |||||||||||
From class
java.lang.Object
|
Construct a Similarity
that delegates all methods to another.
delegee | the Similarity implementation to delegate to |
---|
Computes the normalization value for a field, given the accumulated
state of term processing for this field (see FieldInvertState
).
Implementations should calculate a float value based on the field state and then return that value.
Matches in longer fields are less precise, so implementations of this
method usually return smaller values when state.getLength()
is large,
and larger values when state.getLength()
is small.
Note that the return values are computed under
addDocument(org.apache.lucene.document.Document)
and then stored using
encodeNormValue(float)
.
Thus they have limited precision, and documents
must be re-indexed if this method is altered.
For backward compatibility this method by default calls
lengthNorm(String, int)
passing
getLength()
as the second argument, and
then multiplies this value by getBoost()
.
fieldName | field name |
---|---|
state | current processing state for this field |
Computes a score factor based on the fraction of all query terms that a document contains. This value is multiplied into scores.
The presence of a large portion of the query terms indicates a better match with the query, so implementations of this method usually return larger values when the ratio between these parameters is large and smaller values when the ratio between them is small.
overlap | the number of query terms matched in the document |
---|---|
maxOverlap | the total number of terms in the query |
Computes a score factor based on a term's document frequency (the number
of documents which contain the term). This value is multiplied by the
tf(int)
factor for each term in the query and these products are
then summed to form the initial score for a document.
Terms that occur in fewer documents are better indicators of topic, so implementations of this method usually return larger values for rare terms, and smaller values for common terms.
docFreq | the number of documents which contain the term |
---|---|
numDocs | the total number of documents in the collection |
Computes the normalization value for a query given the sum of the squared weights of each of the query terms. This value is multiplied into the weight of each query term. While the classic query normalization factor is computed as 1/sqrt(sumOfSquaredWeights), other implementations might completely ignore sumOfSquaredWeights (ie return 1).
This does not affect ranking, but the default implementation does make scores from different queries more comparable than they would be by eliminating the magnitude of the Query vector as a factor in the score.
sumOfSquaredWeights | the sum of the squares of query term weights |
---|
Calculate a scoring factor based on the data in the payload. Overriding implementations are responsible for interpreting what is in the payload. Lucene makes no assumptions about what is in the byte array.
The default implementation returns 1.
docId | The docId currently being scored. If this value is NO_DOC_ID_PROVIDED , then it should be assumed that the PayloadQuery implementation does not provide document information |
---|---|
fieldName | The fieldName of the term this payload belongs to |
start | The start position of the payload |
end | The end position of the payload |
payload | The payload byte array to be scored |
offset | The offset into the payload array |
length | The length in the array |
Computes the amount of a sloppy phrase match, based on an edit distance.
This value is summed for each sloppy phrase match in a document to form
the frequency that is passed to tf(float)
.
A phrase match with a small edit distance to a document passage more closely matches the document, so implementations of this method usually return larger values when the edit distance is small and smaller values when it is large.
distance | the edit distance of this sloppy phrase match |
---|
Computes a score factor based on a term or phrase's frequency in a
document. This value is multiplied by the idf(int, int)
factor for each term in the query and these products are then summed to
form the initial score for a document.
Terms and phrases repeated in a document indicate the topic of the
document, so implementations of this method usually return larger values
when freq
is large, and smaller values when freq
is small.
freq | the frequency of a term within a document |
---|