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

Class CustomNormalizer

java.lang.Object
com.azure.search.documents.indexes.models.LexicalNormalizer
com.azure.search.documents.indexes.models.CustomNormalizer
All Implemented Interfaces:
com.azure.json.JsonSerializable<LexicalNormalizer>
public final class CustomNormalizer extends LexicalNormalizer
Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching. This is a user-defined configuration consisting of at least one or more filters, which modify the token that is stored.

  • Constructor Details

    • CustomNormalizer

      public CustomNormalizer(String name)
      Creates an instance of CustomNormalizer 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 normalizer.
      Overrides:
      getOdataType in class LexicalNormalizer
      Returns:
      the odataType value.

    • getTokenFilters

      public List<TokenFilterName> getTokenFilters()
      Get the tokenFilters property: A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed.
      Returns:
      the tokenFilters value.

    • setTokenFilters

      public CustomNormalizer setTokenFilters(List<TokenFilterName> tokenFilters)
      Set the tokenFilters property: A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed.
      Parameters:
      tokenFilters - the tokenFilters value to set.
      Returns:
      the CustomNormalizer object itself.

    • getCharFilters

      public List<CharFilterName> getCharFilters()
      Get the charFilters property: A list of character filters used to prepare input text before it is processed. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed.
      Returns:
      the charFilters value.

    • setCharFilters

      public CustomNormalizer setCharFilters(List<CharFilterName> charFilters)
      Set the charFilters property: A list of character filters used to prepare input text before it is processed. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed.
      Parameters:
      charFilters - the charFilters value to set.
      Returns:
      the CustomNormalizer 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<LexicalNormalizer>
      Overrides:
      toJson in class LexicalNormalizer
      Throws:
      IOException

    • fromJson

      public static CustomNormalizer fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of CustomNormalizer from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of CustomNormalizer 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 CustomNormalizer.