org.elasticsearch.index.similarity

Class DFRSimilarityProvider

java.lang.Object

org.elasticsearch.index.similarity.AbstractSimilarityProvider

org.elasticsearch.index.similarity.DFRSimilarityProvider

All Implemented Interfaces:

SimilarityProvider

public class DFRSimilarityProvider
extends AbstractSimilarityProvider

SimilarityProvider for DFRSimilarity.

Configuration options available:

• basic_model
• after_effect
• normalization

See Also:

For more information about configuration

Nested Class Summary

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

SimilarityProvider.Factory

Field Summary

Fields inherited from class org.elasticsearch.index.similarity.AbstractSimilarityProvider

NO_NORMALIZATION

Constructor Summary

Constructors

Constructor and Description
DFRSimilarityProvider(String name, Settings settings)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.search.similarities.Similarity	get() Returns the Similarity the Provider is for
protected org.apache.lucene.search.similarities.AfterEffect	parseAfterEffect(Settings settings) Parses the given Settings and creates the appropriate AfterEffect
protected org.apache.lucene.search.similarities.BasicModel	parseBasicModel(Settings settings) Parses the given Settings and creates the appropriate BasicModel

Methods inherited from class org.elasticsearch.index.similarity.AbstractSimilarityProvider

name, parseNormalization

Methods inherited from class java.lang.Object

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

Constructor Detail

DFRSimilarityProvider

@Inject
public DFRSimilarityProvider(String name,
                            Settings settings)

Method Detail

parseBasicModel

protected org.apache.lucene.search.similarities.BasicModel parseBasicModel(Settings settings)

Parses the given Settings and creates the appropriate BasicModel

Parameters:

settings - Settings to parse

Returns:

BasicModel referred to in the Settings

parseAfterEffect

protected org.apache.lucene.search.similarities.AfterEffect parseAfterEffect(Settings settings)

Parses the given Settings and creates the appropriate AfterEffect

Parameters:

settings - Settings to parse

Returns:

AfterEffect referred to in the Settings

get

public org.apache.lucene.search.similarities.Similarity get()

Returns the Similarity the Provider is for

Returns:

Provided Similarity