Class CommonGramTokenFilter

java.lang.Object
com.azure.search.documents.indexes.models.TokenFilter
com.azure.search.documents.indexes.models.CommonGramTokenFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<TokenFilter>
public final class CommonGramTokenFilter extends TokenFilter
Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.

  • Constructor Details

    • CommonGramTokenFilter

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

    • getCommonWords

      public List<String> getCommonWords()
      Get the commonWords property: The set of common words.
      Returns:
      the commonWords value.

    • isCaseIgnored

      public Boolean isCaseIgnored()
      Get the caseIgnored property: A value indicating whether common words matching will be case insensitive. Default is false.
      Returns:
      the caseIgnored value.

    • setCaseIgnored

      public CommonGramTokenFilter setCaseIgnored(Boolean caseIgnored)
      Set the caseIgnored property: A value indicating whether common words matching will be case insensitive. Default is false.
      Parameters:
      caseIgnored - the caseIgnored value to set.
      Returns:
      the CommonGramTokenFilter object itself.

    • isQueryModeUsed

      public Boolean isQueryModeUsed()
      Get the queryModeUsed property: A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false.
      Returns:
      the queryModeUsed value.

    • setQueryModeUsed

      public CommonGramTokenFilter setQueryModeUsed(Boolean queryModeUsed)
      Set the queryModeUsed property: A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false.
      Parameters:
      queryModeUsed - the queryModeUsed value to set.
      Returns:
      the CommonGramTokenFilter 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 CommonGramTokenFilter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of CommonGramTokenFilter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of CommonGramTokenFilter 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 CommonGramTokenFilter.