Class AsciiFoldingTokenFilter

java.lang.Object
com.azure.search.documents.indexes.models.TokenFilter
com.azure.search.documents.indexes.models.AsciiFoldingTokenFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<TokenFilter>
public final class AsciiFoldingTokenFilter extends TokenFilter
Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.

  • Constructor Details

    • AsciiFoldingTokenFilter

      public AsciiFoldingTokenFilter(String name)
      Creates an instance of AsciiFoldingTokenFilter 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.

    • isPreserveOriginal

      public Boolean isPreserveOriginal()
      Get the preserveOriginal property: A value indicating whether the original token will be kept. Default is false.
      Returns:
      the preserveOriginal value.

    • setPreserveOriginal

      public AsciiFoldingTokenFilter setPreserveOriginal(Boolean preserveOriginal)
      Set the preserveOriginal property: A value indicating whether the original token will be kept. Default is false.
      Parameters:
      preserveOriginal - the preserveOriginal value to set.
      Returns:
      the AsciiFoldingTokenFilter 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 AsciiFoldingTokenFilter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AsciiFoldingTokenFilter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AsciiFoldingTokenFilter 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 AsciiFoldingTokenFilter.