Class PhoneticTokenFilter

java.lang.Object
com.azure.search.documents.indexes.models.TokenFilter
com.azure.search.documents.indexes.models.PhoneticTokenFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<TokenFilter>
public final class PhoneticTokenFilter extends TokenFilter
Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.

  • Constructor Details

    • PhoneticTokenFilter

      public PhoneticTokenFilter(String name)
      Creates an instance of PhoneticTokenFilter class.
      Parameters:
      name - the name value to set.

  • Method Details

    • getOdataType

      public String getOdataType()
      Get the odataType property: A URI fragment specifying the type of token filter.
      Overrides:
      getOdataType in class TokenFilter
      Returns:
      the odataType value.

    • getEncoder

      public PhoneticEncoder getEncoder()
      Get the encoder property: The phonetic encoder to use. Default is "metaphone".
      Returns:
      the encoder value.

    • setEncoder

      public PhoneticTokenFilter setEncoder(PhoneticEncoder encoder)
      Set the encoder property: The phonetic encoder to use. Default is "metaphone".
      Parameters:
      encoder - the encoder value to set.
      Returns:
      the PhoneticTokenFilter object itself.

    • areOriginalTokensReplaced

      public Boolean areOriginalTokensReplaced()
      Get the originalTokensReplaced property: A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true.
      Returns:
      the originalTokensReplaced value.

    • setOriginalTokensReplaced

      public PhoneticTokenFilter setOriginalTokensReplaced(Boolean originalTokensReplaced)
      Set the originalTokensReplaced property: A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true.
      Parameters:
      originalTokensReplaced - the originalTokensReplaced value to set.
      Returns:
      the PhoneticTokenFilter object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<TokenFilter>
      Overrides:
      toJson in class TokenFilter
      Throws:
      IOException

    • fromJson

      public static PhoneticTokenFilter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PhoneticTokenFilter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PhoneticTokenFilter if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the PhoneticTokenFilter.