Package org.elasticsearch.index.similarity

Class AbstractSimilarityProvider

java.lang.Object

org.elasticsearch.index.similarity.AbstractSimilarityProvider

All Implemented Interfaces:

SimilarityProvider

Direct Known Subclasses:

BM25SimilarityProvider, BooleanSimilarityProvider, ClassicSimilarityProvider, DFISimilarityProvider, DFRSimilarityProvider, IBSimilarityProvider, LMDirichletSimilarityProvider, LMJelinekMercerSimilarityProvider, ScriptedSimilarityProvider

public abstract class AbstractSimilarityProvider
extends java.lang.Object
implements SimilarityProvider

Abstract implementation of SimilarityProvider providing common behaviour

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.index.similarity.SimilarityProvider

SimilarityProvider.Factory

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.lucene.search.similarities.Normalization	NO_NORMALIZATION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSimilarityProvider(java.lang.String name)	Creates a new AbstractSimilarityProvider with the given name

Method Summary

Modifier and Type	Method	Description
java.lang.String	name()	Returns the name associated with the Provider
protected org.apache.lucene.search.similarities.Normalization	parseNormalization(Settings settings)	Parses the given Settings and creates the appropriate Normalization

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.similarity.SimilarityProvider

get

Field Detail

NO_NORMALIZATION

protected static final org.apache.lucene.search.similarities.Normalization NO_NORMALIZATION

Constructor Detail

AbstractSimilarityProvider

protected AbstractSimilarityProvider(java.lang.String name)

Creates a new AbstractSimilarityProvider with the given name

Parameters:

name - Name of the Provider

Method Detail

name

public java.lang.String name()

Returns the name associated with the Provider

Specified by:

name in interface SimilarityProvider

Returns:

Name of the Provider

parseNormalization

protected org.apache.lucene.search.similarities.Normalization parseNormalization(Settings settings)

Parses the given Settings and creates the appropriate Normalization

Parameters:

settings - Settings to parse

Returns:

Normalization referred to in the Settings