Package org.elasticsearch.search.suggest.completion

Class FuzzyOptions

java.lang.Object

org.elasticsearch.search.suggest.completion.FuzzyOptions

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public class FuzzyOptions
extends java.lang.Object
implements ToXContentFragment, Writeable

Fuzzy options for completion suggester

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FuzzyOptions.Builder	Options for fuzzy queries

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static FuzzyOptions.Builder	builder()
boolean	equals(java.lang.Object o)
int	getEditDistance()	Returns the maximum number of edits
int	getFuzzyMinLength()	Returns the length of input prefix after which edits are applied
int	getFuzzyPrefixLength()	Returns the minimum length of the input prefix required to apply any edits
int	getMaxDeterminizedStates()	Returns the maximum automaton states allowed for fuzzy expansion
int	hashCode()
boolean	isTranspositions()	Returns if transpositions option is set if transpositions is set, then swapping one character for another counts as one edit instead of two.
boolean	isUnicodeAware()	Returns if all measurements (like edit distance, transpositions and lengths) are in unicode code points (actual letters) instead of bytes.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Method Detail

builder

public static FuzzyOptions.Builder builder()

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

getEditDistance

public int getEditDistance()

Returns the maximum number of edits

isTranspositions

public boolean isTranspositions()

Returns if transpositions option is set if transpositions is set, then swapping one character for another counts as one edit instead of two.

getFuzzyMinLength

public int getFuzzyMinLength()

Returns the length of input prefix after which edits are applied

getFuzzyPrefixLength

public int getFuzzyPrefixLength()

Returns the minimum length of the input prefix required to apply any edits

isUnicodeAware

public boolean isUnicodeAware()

Returns if all measurements (like edit distance, transpositions and lengths) are in unicode code points (actual letters) instead of bytes.

getMaxDeterminizedStates

public int getMaxDeterminizedStates()

Returns the maximum automaton states allowed for fuzzy expansion

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException