Class LengthTokenFilter

java.lang.Object
com.azure.search.documents.indexes.models.TokenFilter
com.azure.search.documents.indexes.models.LengthTokenFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<TokenFilter>
public final class LengthTokenFilter extends TokenFilter
Removes words that are too long or too short. This token filter is implemented using Apache Lucene.

  • Constructor Details

    • LengthTokenFilter

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

    • getMinLength

      public Integer getMinLength()
      Get the minLength property: The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max.
      Returns:
      the minLength value.

    • setMinLength

      public LengthTokenFilter setMinLength(Integer minLength)
      Set the minLength property: The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max.
      Parameters:
      minLength - the minLength value to set.
      Returns:
      the LengthTokenFilter object itself.

    • getMaxLength

      public Integer getMaxLength()
      Get the maxLength property: The maximum length in characters. Default and maximum is 300.
      Returns:
      the maxLength value.

    • setMaxLength

      public LengthTokenFilter setMaxLength(Integer maxLength)
      Set the maxLength property: The maximum length in characters. Default and maximum is 300.
      Parameters:
      maxLength - the maxLength value to set.
      Returns:
      the LengthTokenFilter 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 LengthTokenFilter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of LengthTokenFilter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of LengthTokenFilter 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 LengthTokenFilter.