org.elasticsearch.index.similarity

Class SimilarityModule

java.lang.Object

org.elasticsearch.common.inject.AbstractModule

org.elasticsearch.index.similarity.SimilarityModule

All Implemented Interfaces:

Module

public class SimilarityModule
extends AbstractModule

SimilarityModule is responsible gathering registered and configured SimilarityProvider implementations and making them available through the SimilarityLookupService and SimilarityService. New SimilarityProvider implementations can be registered through addSimilarity(String, Class) while existing Providers can be referenced through Settings under the SIMILARITY_SETTINGS_PREFIX prefix along with the "type" value. For example, to reference the BM25SimilarityProvider, the configuration "index.similarity.my_similarity.type : "BM25" can be used.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIMILARITY_SETTINGS_PREFIX

Constructor Summary

Constructors

Constructor and Description
SimilarityModule(Settings settings)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSimilarity(String name, Class<? extends SimilarityProvider> similarity) Registers the given SimilarityProvider with the given name
protected void	configure() Configures a Binder via the exposed methods.

Methods inherited from class org.elasticsearch.common.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Field Detail

SIMILARITY_SETTINGS_PREFIX

public static final String SIMILARITY_SETTINGS_PREFIX

See Also:

Constant Field Values

Constructor Detail

SimilarityModule

public SimilarityModule(Settings settings)

Method Detail

addSimilarity

public void addSimilarity(String name,
                 Class<? extends SimilarityProvider> similarity)

Registers the given SimilarityProvider with the given name

Parameters:

name - Name of the SimilarityProvider

similarity - SimilarityProvider to register

configure

protected void configure()

Description copied from class: AbstractModule

Configures a Binder via the exposed methods.

Specified by:

configure in class AbstractModule