org.elasticsearch.common.unit

Class Fuzziness

java.lang.Object

org.elasticsearch.common.unit.Fuzziness

All Implemented Interfaces:

ToXContent

public final class Fuzziness
extends Object
implements ToXContent

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

Field Summary

Fields

Modifier and Type	Field and Description
static Fuzziness	AUTO
static ParseField	FIELD
static Fuzziness	ONE
static Fuzziness	TWO
static XContentBuilderString	X_FIELD_NAME
static Fuzziness	ZERO

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

EMPTY_PARAMS

Method Summary

Methods

Modifier and Type	Method and Description
byte	asByte()
int	asDistance()
int	asDistance(String text)
double	asDouble()
float	asFloat()
int	asInt()
long	asLong()
short	asShort()
String	asString()
TimeValue	asTimeValue()
static Fuzziness	build(Object fuzziness)
static Fuzziness	fromEdits(int edits) Creates a Fuzziness instance from an edit distance.
static Fuzziness	parse(XContentParser parser)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params, boolean includeFieldName)

Methods inherited from class java.lang.Object

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

Field Detail

X_FIELD_NAME

public static final XContentBuilderString X_FIELD_NAME

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

Method Detail

fromEdits

public static Fuzziness fromEdits(int edits)

Creates a Fuzziness instance from an edit distance. The value must be one of [0, 1, 2]

build

public static Fuzziness build(Object fuzziness)

parse

public static Fuzziness parse(XContentParser parser)
                       throws IOException

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContent

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

Throws:

IOException

asDistance

public int asDistance()

asDistance

public int asDistance(String text)

asTimeValue

public TimeValue asTimeValue()

asLong

public long asLong()

asInt

public int asInt()

asShort

public short asShort()

asByte

public byte asByte()

asDouble

public double asDouble()

asFloat

public float asFloat()

asString

public String asString()