Class KeywordMarkerTokenFilter

java.lang.Object
com.azure.search.documents.indexes.models.TokenFilter
com.azure.search.documents.indexes.models.KeywordMarkerTokenFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<TokenFilter>
public final class KeywordMarkerTokenFilter extends TokenFilter
Marks terms as keywords. This token filter is implemented using Apache Lucene.

  • Constructor Details

    • KeywordMarkerTokenFilter

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

    • getKeywords

      public List<String> getKeywords()
      Get the keywords property: A list of words to mark as keywords.
      Returns:
      the keywords value.

    • isCaseIgnored

      public Boolean isCaseIgnored()
      Get the caseIgnored property: A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false.
      Returns:
      the caseIgnored value.

    • setCaseIgnored

      public KeywordMarkerTokenFilter setCaseIgnored(Boolean caseIgnored)
      Set the caseIgnored property: A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false.
      Parameters:
      caseIgnored - the caseIgnored value to set.
      Returns:
      the KeywordMarkerTokenFilter 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 KeywordMarkerTokenFilter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of KeywordMarkerTokenFilter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of KeywordMarkerTokenFilter 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 KeywordMarkerTokenFilter.