Enum TermSuggestionBuilder.StringDistanceImpl
java.lang.Object
java.lang.Enum<TermSuggestionBuilder.StringDistanceImpl>
org.elasticsearch.search.suggest.term.TermSuggestionBuilder.StringDistanceImpl
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<TermSuggestionBuilder.StringDistanceImpl>,java.lang.constant.Constable,Writeable
- Enclosing class:
- TermSuggestionBuilder
public static enum TermSuggestionBuilder.StringDistanceImpl extends java.lang.Enum<TermSuggestionBuilder.StringDistanceImpl> implements Writeable
An enum representing the valid string edit distance algorithms for determining suggestions.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Enum Constant Summary
Enum Constants Enum Constant Description DAMERAU_LEVENSHTEINString distance algorithm based on Damerau-Levenshtein algorithm.INTERNALThis is the default and is based ondamerau_levenshtein, but highly optimized for comparing string distance for terms inside the index.JARO_WINKLERString distance algorithm based on Jaro-Winkler algorithm.LEVENSHTEINString distance algorithm based on Levenshtein edit distance algorithm.NGRAMString distance algorithm based on character n-grams. -
Method Summary
Modifier and Type Method Description static TermSuggestionBuilder.StringDistanceImplreadFromStream(StreamInput in)static TermSuggestionBuilder.StringDistanceImplresolve(java.lang.String str)abstract org.apache.lucene.search.spell.StringDistancetoLucene()static TermSuggestionBuilder.StringDistanceImplvalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static TermSuggestionBuilder.StringDistanceImpl[]values()Returns an array containing the constants of this enum type, in the order they are declared.voidwriteTo(StreamOutput out)Write this into the StreamOutput.
-
Enum Constant Details
-
INTERNAL
This is the default and is based ondamerau_levenshtein, but highly optimized for comparing string distance for terms inside the index. -
DAMERAU_LEVENSHTEIN
String distance algorithm based on Damerau-Levenshtein algorithm. -
LEVENSHTEIN
String distance algorithm based on Levenshtein edit distance algorithm. -
JARO_WINKLER
String distance algorithm based on Jaro-Winkler algorithm. -
NGRAM
String distance algorithm based on character n-grams.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException- if this enum type has no constant with the specified namejava.lang.NullPointerException- if the argument is null
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput. -
readFromStream
public static TermSuggestionBuilder.StringDistanceImpl readFromStream(StreamInput in) throws java.io.IOException- Throws:
java.io.IOException
-
resolve
-
toLucene
public abstract org.apache.lucene.search.spell.StringDistance toLucene()
-