org.elasticsearch.index.similarity

Class BooleanSimilarityProvider

java.lang.Object

org.elasticsearch.index.similarity.AbstractSimilarityProvider

org.elasticsearch.index.similarity.BooleanSimilarityProvider

All Implemented Interfaces:

SimilarityProvider

public class BooleanSimilarityProvider
extends AbstractSimilarityProvider

SimilarityProvider for the BooleanSimilarity, which is a simple similarity that gives terms a score equal to their query boost only. This is useful in situations where a field does not need to be scored by a full-text ranking algorithm, but rather all that matters is whether the query terms matched or not.

Field Summary

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

NO_NORMALIZATION

Constructor Summary

Constructors

Constructor and Description
BooleanSimilarityProvider(java.lang.String name, Settings settings)

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.similarities.BooleanSimilarity	get() Returns the Similarity the Provider is for

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

BooleanSimilarityProvider

public BooleanSimilarityProvider(java.lang.String name,
                                 Settings settings)

Method Detail

get

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

Returns the Similarity the Provider is for

Returns:

Provided Similarity