org.apache.lucene.search.similarities

Class PerFieldSimilarityWrapper.PerFieldSimWeight

java.lang.Object

org.apache.lucene.search.similarities.Similarity.SimWeight

org.apache.lucene.search.similarities.PerFieldSimilarityWrapper.PerFieldSimWeight

Enclosing class:

PerFieldSimilarityWrapper

static class PerFieldSimilarityWrapper.PerFieldSimWeight
extends Similarity.SimWeight

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Similarity	delegate
(package private) Similarity.SimWeight	delegateWeight

Constructor Summary

Constructors

Constructor and Description
PerFieldSimWeight()

Method Summary

Modifier and Type	Method and Description
float	getValueForNormalization() The value for normalization of contained query clauses (e.g.
void	normalize(float queryNorm, float boost) Assigns the query normalization factor and boost from parent queries to this.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

delegate

Similarity delegate

delegateWeight

Similarity.SimWeight delegateWeight

Constructor Detail

PerFieldSimWeight

PerFieldSimWeight()

Method Detail

getValueForNormalization

public float getValueForNormalization()

Description copied from class: Similarity.SimWeight

The value for normalization of contained query clauses (e.g. sum of squared weights).

NOTE: a Similarity implementation might not use any query normalization at all, it's not required. However, if it wants to participate in query normalization, it can return a value here.

Specified by:

getValueForNormalization in class Similarity.SimWeight

normalize

public void normalize(float queryNorm,
                      float boost)

Description copied from class: Similarity.SimWeight

Assigns the query normalization factor and boost from parent queries to this.

NOTE: a Similarity implementation might not use this normalized value at all, it's not required. However, it's usually a good idea to at least incorporate the boost into its score.

NOTE: If this method is called several times, it behaves as if only the last call was performed.

Specified by:

normalize in class Similarity.SimWeight