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

Class CustomAnalyzer

java.lang.Object
com.azure.search.documents.indexes.models.LexicalAnalyzer
com.azure.search.documents.indexes.models.CustomAnalyzer
All Implemented Interfaces:
com.azure.json.JsonSerializable<LexicalAnalyzer>
public final class CustomAnalyzer extends LexicalAnalyzer
Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer.

  • Constructor Details

    • CustomAnalyzer

      public CustomAnalyzer(String name, LexicalTokenizerName tokenizer)
      Creates an instance of CustomAnalyzer class.
      Parameters:
      name - the name value to set.
      tokenizer - the tokenizer value to set.

  • Method Details

    • getOdataType

      public String getOdataType()
      Get the odataType property: A URI fragment specifying the type of analyzer.
      Overrides:
      getOdataType in class LexicalAnalyzer
      Returns:
      the odataType value.

    • getTokenizer

      public LexicalTokenizerName getTokenizer()
      Get the tokenizer property: The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words.
      Returns:
      the tokenizer value.

    • getTokenFilters

      public List<TokenFilterName> getTokenFilters()
      Get the tokenFilters property: A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed.
      Returns:
      the tokenFilters value.

    • setTokenFilters

      public CustomAnalyzer setTokenFilters(List<TokenFilterName> tokenFilters)
      Set the tokenFilters property: A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed.
      Parameters:
      tokenFilters - the tokenFilters value to set.
      Returns:
      the CustomAnalyzer object itself.

    • getCharFilters

      public List<CharFilterName> getCharFilters()
      Get the charFilters property: A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed.
      Returns:
      the charFilters value.

    • setCharFilters

      public CustomAnalyzer setCharFilters(List<CharFilterName> charFilters)
      Set the charFilters property: A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed.
      Parameters:
      charFilters - the charFilters value to set.
      Returns:
      the CustomAnalyzer 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<LexicalAnalyzer>
      Overrides:
      toJson in class LexicalAnalyzer
      Throws:
      IOException

    • fromJson

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

    • setTokenFilters

      public CustomAnalyzer setTokenFilters(TokenFilterName... tokenFilters)
      Set the tokenFilters property: A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed.
      Parameters:
      tokenFilters - the tokenFilters value to set.
      Returns:
      the CustomAnalyzer object itself.

    • setCharFilters

      public CustomAnalyzer setCharFilters(CharFilterName... charFilters)
      Set the charFilters property: A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed.
      Parameters:
      charFilters - the charFilters value to set.
      Returns:
      the CustomAnalyzer object itself.