Class StemmerOverrideTokenFilter

java.lang.Object
com.azure.search.documents.indexes.models.TokenFilter
com.azure.search.documents.indexes.models.StemmerOverrideTokenFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<TokenFilter>
public final class StemmerOverrideTokenFilter extends TokenFilter
Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.

  • Constructor Details

    • StemmerOverrideTokenFilter

      public StemmerOverrideTokenFilter(String name, List<String> rules)
      Creates an instance of StemmerOverrideTokenFilter class.
      Parameters:
      name - the name value to set.
      rules - the rules 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.

    • getRules

      public List<String> getRules()
      Get the rules property: A list of stemming rules in the following format: "word => stem", for example: "ran => run".
      Returns:
      the rules value.

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