Package org.apache.solr.ltr.norm

Class Normalizer

java.lang.Object

org.apache.solr.ltr.norm.Normalizer

Direct Known Subclasses:

IdentityNormalizer, MinMaxNormalizer, StandardNormalizer

public abstract class Normalizer
extends Object

A normalizer normalizes the value of a feature. After the feature values have been computed, the normalize(float) methods will be called and the resulting values will be used by the model.

Constructor Summary

Constructors

Constructor	Description
Normalizer()

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.Explanation	explain(org.apache.lucene.search.Explanation explain)
static Normalizer	getInstance(SolrResourceLoader solrResourceLoader, String className, Map<String,Object> params)
abstract float	normalize(float value)
abstract LinkedHashMap<String,Object>	paramsToMap()
protected abstract void	validate()	As part of creation of a normalizer instance, this function confirms that the normalizer parameters are valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

Normalizer

public Normalizer()

Method Detail

normalize

public abstract float normalize(float value)

paramsToMap

public abstract LinkedHashMap<String,Object> paramsToMap()

explain

public org.apache.lucene.search.Explanation explain(org.apache.lucene.search.Explanation explain)

getInstance

public static Normalizer getInstance(SolrResourceLoader solrResourceLoader,
                                     String className,
                                     Map<String,Object> params)

validate

protected abstract void validate()
                          throws NormalizerException

As part of creation of a normalizer instance, this function confirms that the normalizer parameters are valid.

Throws:

NormalizerException - Normalizer Exception