org.elasticsearch.index.similarity

Class SimilarityLookupService

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.similarity.SimilarityLookupService

All Implemented Interfaces:

IndexComponent

public class SimilarityLookupService
extends AbstractIndexComponent

Service for looking up configured SimilarityProvider implementations by name.

The service instantiates the Providers through their Factories using configuration values found with the SimilarityModule.SIMILARITY_SETTINGS_PREFIX prefix.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SIMILARITY

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

componentSettings, index, indexSettings, logger

Constructor Summary

Constructors

Constructor and Description
SimilarityLookupService(Index index, Settings indexSettings)
SimilarityLookupService(Index index, Settings indexSettings, Map<String,SimilarityProvider.Factory> similarities)

Method Summary

Modifier and Type	Method and Description
SimilarityProvider	similarity(String name) Returns the SimilarityProvider with the given name

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

index, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SIMILARITY

public static final String DEFAULT_SIMILARITY

See Also:

Constant Field Values

Constructor Detail

SimilarityLookupService

public SimilarityLookupService(Index index,
                               Settings indexSettings)

SimilarityLookupService

@Inject
public SimilarityLookupService(Index index,
                                       @IndexSettings
                                       Settings indexSettings,
                                       Map<String,SimilarityProvider.Factory> similarities)

Method Detail

similarity

public SimilarityProvider similarity(String name)

Returns the SimilarityProvider with the given name

Parameters:

name - Name of the SimilarityProvider to find

Returns:

SimilarityProvider with the given name, or null if no Provider exists