Module org.elasticsearch.server
Package org.elasticsearch.common.unit

Class Fuzziness

java.lang.Object
org.elasticsearch.common.unit.Fuzziness
All Implemented Interfaces:
Writeable, ToXContent, ToXContentFragment
public final class Fuzziness extends Object implements ToXContentFragment, Writeable
A unit class that encapsulates all in-exact search parsing and conversion from similarities to edit distances etc.

  • Field Details

  • Constructor Details

  • Method Details

    • 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.
      Throws:
      IllegalArgumentException - if the edit distance is not in [0, 1, 2]

    • fromString

      public static Fuzziness fromString(String fuzzinessString)
      Creates a Fuzziness instance from a String representation. This can either be an edit distance where the value must be one of ["0", "1", "2"] or "AUTO" for a fuzziness that depends on the term length. Using the "AUTO" fuzziness, you can optionally supply low and high distance arguments in the format "AUTO:[low],[high]". See the query DSL documentation for more information about how these values affect the fuzziness value. Note: Using this method only makes sense if the field you are applying Fuzziness to is some sort of string.

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • 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

    • asDistance

      public int asDistance()

    • asDistance

      public int asDistance(String text)

    • asFloat

      public float asFloat()

    • asString

      public String asString()

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object