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

Class UniqueTokenFilter

java.lang.Object
com.azure.search.documents.indexes.models.TokenFilter
com.azure.search.documents.indexes.models.UniqueTokenFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<TokenFilter>
public final class UniqueTokenFilter extends TokenFilter
Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.

  • Constructor Summary

    Constructors
    Constructor
    Description
    UniqueTokenFilter(String name)
    Creates an instance of UniqueTokenFilter class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static UniqueTokenFilter
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of UniqueTokenFilter from the JsonReader.
    String
    getOdataType()
    Get the odataType property: A URI fragment specifying the type of token filter.
    Boolean
    isOnlyOnSamePosition()
    Get the onlyOnSamePosition property: A value indicating whether to remove duplicates only at the same position.
    UniqueTokenFilter
    setOnlyOnSamePosition(Boolean onlyOnSamePosition)
    Set the onlyOnSamePosition property: A value indicating whether to remove duplicates only at the same position.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class com.azure.search.documents.indexes.models.TokenFilter

    getName

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • UniqueTokenFilter

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

    • isOnlyOnSamePosition

      public Boolean isOnlyOnSamePosition()
      Get the onlyOnSamePosition property: A value indicating whether to remove duplicates only at the same position. Default is false.
      Returns:
      the onlyOnSamePosition value.

    • setOnlyOnSamePosition

      public UniqueTokenFilter setOnlyOnSamePosition(Boolean onlyOnSamePosition)
      Set the onlyOnSamePosition property: A value indicating whether to remove duplicates only at the same position. Default is false.
      Parameters:
      onlyOnSamePosition - the onlyOnSamePosition value to set.
      Returns:
      the UniqueTokenFilter 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 UniqueTokenFilter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of UniqueTokenFilter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of UniqueTokenFilter 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 UniqueTokenFilter.