Package co.elastic.clients.elasticsearch.core.search

Enum Class StringDistance

java.lang.Object

java.lang.Enum<StringDistance>

co.elastic.clients.elasticsearch.core.search.StringDistance

All Implemented Interfaces:

JsonEnum, JsonpSerializable, Serializable, Comparable<StringDistance>, Constable

@JsonpDeserializable
public enum StringDistance
extends Enum<StringDistance>
implements JsonEnum

See Also:

• API specification

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DamerauLevenshtein	String distance algorithm based on Damerau-Levenshtein algorithm.
Internal	Based on the Damerau-Levenshtein algorithm, but highly optimized for comparing string distance for terms inside the index.
JaroWinkler	String distance algorithm based on Jaro-Winkler algorithm.
Levenshtein	String distance algorithm based on the Levenshtein edit distance algorithm.
Ngram	String distance algorithm based on character n-grams.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<StringDistance>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static StringDistance	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StringDistance[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.JsonEnum

aliases, serialize

Enum Constant Details

Internal

public static final StringDistance Internal

Based on the Damerau-Levenshtein algorithm, but highly optimized for comparing string distance for terms inside the index.

DamerauLevenshtein

public static final StringDistance DamerauLevenshtein

String distance algorithm based on Damerau-Levenshtein algorithm.

Levenshtein

public static final StringDistance Levenshtein

String distance algorithm based on the Levenshtein edit distance algorithm.

JaroWinkler

public static final StringDistance JaroWinkler

String distance algorithm based on Jaro-Winkler algorithm.

Ngram

public static final StringDistance Ngram

String distance algorithm based on character n-grams.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<StringDistance> _DESERIALIZER

Method Details

values

public static StringDistance[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static StringDistance valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum