Package com.azure.search.documents.indexes.models

Enum PhoneticEncoder

java.lang.Object
java.lang.Enum<PhoneticEncoder>
com.azure.search.documents.indexes.models.PhoneticEncoder
All Implemented Interfaces:
Serializable, Comparable<PhoneticEncoder>, java.lang.constant.Constable
public enum PhoneticEncoder extends Enum<PhoneticEncoder>
Identifies the type of phonetic encoder to use with a PhoneticTokenFilter.

  • Enum Constant Details

    • METAPHONE

      public static final PhoneticEncoder METAPHONE
      Encodes a token into a Metaphone value.

    • DOUBLE_METAPHONE

      public static final PhoneticEncoder DOUBLE_METAPHONE
      Encodes a token into a double metaphone value.

    • SOUNDEX

      public static final PhoneticEncoder SOUNDEX
      Encodes a token into a Soundex value.

    • REFINED_SOUNDEX

      public static final PhoneticEncoder REFINED_SOUNDEX
      Encodes a token into a Refined Soundex value.

    • CAVERPHONE1

      public static final PhoneticEncoder CAVERPHONE1
      Encodes a token into a Caverphone 1.0 value.

    • CAVERPHONE2

      public static final PhoneticEncoder CAVERPHONE2
      Encodes a token into a Caverphone 2.0 value.

    • COLOGNE

      public static final PhoneticEncoder COLOGNE
      Encodes a token into a Cologne Phonetic value.

    • NYSIIS

      public static final PhoneticEncoder NYSIIS
      Encodes a token into a NYSIIS value.

    • KOELNER_PHONETIK

      public static final PhoneticEncoder KOELNER_PHONETIK
      Encodes a token using the Kölner Phonetik algorithm.

    • HAASE_PHONETIK

      public static final PhoneticEncoder HAASE_PHONETIK
      Encodes a token using the Haase refinement of the Kölner Phonetik algorithm.

    • BEIDER_MORSE

      public static final PhoneticEncoder BEIDER_MORSE
      Encodes a token into a Beider-Morse value.

  • Method Details

    • values

      public static PhoneticEncoder[] 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

      public static PhoneticEncoder valueOf(String name)
      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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • fromString

      public static PhoneticEncoder fromString(String value)
      Parses a serialized value to a PhoneticEncoder instance.
      Parameters:
      value - the serialized value to parse.
      Returns:
      the parsed PhoneticEncoder object, or null if unable to parse.

    • toString

      public String toString()
      Overrides:
      toString in class Enum<PhoneticEncoder>