Package org.elasticsearch.index.similarity

Class SimilarityService

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.similarity.SimilarityService

All Implemented Interfaces:

IndexComponent

public final class SimilarityService
extends AbstractIndexComponent

Field Summary

Fields

Modifier and Type	Field	Description
static Map<String,TriFunction<Settings,Version,ScriptService,org.apache.lucene.search.similarities.Similarity>>	BUILT_IN
static String	DEFAULT_SIMILARITY

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

indexSettings, logger

Constructor Summary

Constructors

Constructor	Description
SimilarityService(IndexSettings indexSettings, ScriptService scriptService, Map<String,TriFunction<Settings,Version,ScriptService,org.apache.lucene.search.similarities.Similarity>> similarities)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.similarities.Similarity	getDefaultSimilarity()	The default similarity configured in the index settings.
SimilarityProvider	getSimilarity(String name)
org.apache.lucene.search.similarities.Similarity	similarity(Function<String,MappedFieldType> fieldTypeLookup)	The similarity to use in searches, which takes into account per-field configuration.

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

getIndexSettings, index

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SIMILARITY

public static final String DEFAULT_SIMILARITY

See Also:

Constant Field Values

BUILT_IN

public static final Map<String,TriFunction<Settings,Version,ScriptService,org.apache.lucene.search.similarities.Similarity>> BUILT_IN

Constructor Details

SimilarityService

public SimilarityService(IndexSettings indexSettings,
 ScriptService scriptService,
 Map<String,TriFunction<Settings,Version,ScriptService,org.apache.lucene.search.similarities.Similarity>> similarities)

Method Details

similarity

public org.apache.lucene.search.similarities.Similarity similarity(@Nullable
 Function<String,MappedFieldType> fieldTypeLookup)

The similarity to use in searches, which takes into account per-field configuration.

getSimilarity

public SimilarityProvider getSimilarity(String name)

getDefaultSimilarity

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

The default similarity configured in the index settings.