Class NGramTokenizer

java.lang.Object
com.azure.search.documents.indexes.models.LexicalTokenizer
com.azure.search.documents.indexes.models.NGramTokenizer
All Implemented Interfaces:
com.azure.json.JsonSerializable<LexicalTokenizer>
public final class NGramTokenizer extends LexicalTokenizer
Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.

  • Constructor Details

    • NGramTokenizer

      public NGramTokenizer(String name)
      Creates an instance of NGramTokenizer 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 tokenizer.
      Overrides:
      getOdataType in class LexicalTokenizer
      Returns:
      the odataType value.

    • getMinGram

      public Integer getMinGram()
      Get the minGram property: The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram.
      Returns:
      the minGram value.

    • setMinGram

      public NGramTokenizer setMinGram(Integer minGram)
      Set the minGram property: The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram.
      Parameters:
      minGram - the minGram value to set.
      Returns:
      the NGramTokenizer object itself.

    • getMaxGram

      public Integer getMaxGram()
      Get the maxGram property: The maximum n-gram length. Default is 2. Maximum is 300.
      Returns:
      the maxGram value.

    • setMaxGram

      public NGramTokenizer setMaxGram(Integer maxGram)
      Set the maxGram property: The maximum n-gram length. Default is 2. Maximum is 300.
      Parameters:
      maxGram - the maxGram value to set.
      Returns:
      the NGramTokenizer object itself.

    • getTokenChars

      public List<TokenCharacterKind> getTokenChars()
      Get the tokenChars property: Character classes to keep in the tokens.
      Returns:
      the tokenChars value.

    • setTokenChars

      public NGramTokenizer setTokenChars(List<TokenCharacterKind> tokenChars)
      Set the tokenChars property: Character classes to keep in the tokens.
      Parameters:
      tokenChars - the tokenChars value to set.
      Returns:
      the NGramTokenizer 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<LexicalTokenizer>
      Overrides:
      toJson in class LexicalTokenizer
      Throws:
      IOException

    • fromJson

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

    • setTokenChars

      public NGramTokenizer setTokenChars(TokenCharacterKind... tokenChars)
      Set the tokenChars property: Character classes to keep in the tokens.
      Parameters:
      tokenChars - the tokenChars value to set.
      Returns:
      the NGramTokenizer object itself.