org.elasticsearch.common.unit

Class Fuzziness

java.lang.Object

org.elasticsearch.common.unit.Fuzziness

All Implemented Interfaces:

Writeable, ToXContent

public final class Fuzziness
extends java.lang.Object
implements ToXContent, Writeable

A unit class that encapsulates all in-exact search parsing and conversion from similarities to edit distances etc.

Nested Class Summary

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

Modifier and Type	Field and Description
static Fuzziness	AUTO
static ParseField	FIELD
static Fuzziness	ONE
static Fuzziness	TWO
static java.lang.String	X_FIELD_NAME
static Fuzziness	ZERO

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Fuzziness(StreamInput in) Read from a stream.

Method Summary

Modifier and Type	Method and Description
int	asDistance()
int	asDistance(java.lang.String text)
float	asFloat()
java.lang.String	asString()
static Fuzziness	build(java.lang.Object fuzziness)
boolean	equals(java.lang.Object obj)
static Fuzziness	fromEdits(int edits) Creates a Fuzziness instance from an edit distance.
int	hashCode()
static Fuzziness	parse(XContentParser parser)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params, boolean includeFieldName)
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

Field Detail

X_FIELD_NAME

public static final java.lang.String X_FIELD_NAME

See Also:

Constant Field Values

ZERO

public static final Fuzziness ZERO

ONE

public static final Fuzziness ONE

TWO

public static final Fuzziness TWO

AUTO

public static final Fuzziness AUTO

FIELD

public static final ParseField FIELD

Constructor Detail

Fuzziness

public Fuzziness(StreamInput in)
          throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

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

fromEdits

public static Fuzziness fromEdits(int edits)

Creates a Fuzziness instance from an edit distance. The value must be one of [0, 1, 2] Note: Using this method only makes sense if the field you are applying Fuzziness to is some sort of string.

build

public static Fuzziness build(java.lang.Object fuzziness)

parse

public static Fuzziness parse(XContentParser parser)
                       throws java.io.IOException

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toXContent

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

Throws:

java.io.IOException

asDistance

public int asDistance()

asDistance

public int asDistance(java.lang.String text)

asFloat

public float asFloat()

asString

public java.lang.String asString()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object