Class PatternTokenizer

java.lang.Object
com.azure.search.documents.indexes.models.LexicalTokenizer
com.azure.search.documents.indexes.models.PatternTokenizer
All Implemented Interfaces:
com.azure.json.JsonSerializable<LexicalTokenizer>
public final class PatternTokenizer extends LexicalTokenizer
Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.

  • Constructor Details

    • PatternTokenizer

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

    • getPattern

      public String getPattern()
      Get the pattern property: A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters.
      Returns:
      the pattern value.

    • setPattern

      public PatternTokenizer setPattern(String pattern)
      Set the pattern property: A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters.
      Parameters:
      pattern - the pattern value to set.
      Returns:
      the PatternTokenizer object itself.

    • getFlags

      public List<RegexFlags> getFlags()
      Get the flags property: Regular expression flags.
      Returns:
      the flags value.

    • setFlags

      public PatternTokenizer setFlags(List<RegexFlags> flags)
      Set the flags property: Regular expression flags.
      Parameters:
      flags - the flags value to set.
      Returns:
      the PatternTokenizer object itself.

    • getGroup

      public Integer getGroup()
      Get the group property: The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1.
      Returns:
      the group value.

    • setGroup

      public PatternTokenizer setGroup(Integer group)
      Set the group property: The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1.
      Parameters:
      group - the group value to set.
      Returns:
      the PatternTokenizer 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 PatternTokenizer fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PatternTokenizer from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PatternTokenizer 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 PatternTokenizer.

    • setFlags

      public PatternTokenizer setFlags(RegexFlags... flags)
      Set the flags property: Regular expression flags.
      Parameters:
      flags - the flags value to set.
      Returns:
      the PatternTokenizer object itself.