Class PatternAnalyzer

java.lang.Object
com.azure.search.documents.indexes.models.LexicalAnalyzer
com.azure.search.documents.indexes.models.PatternAnalyzer
All Implemented Interfaces:
com.azure.json.JsonSerializable<LexicalAnalyzer>
public final class PatternAnalyzer extends LexicalAnalyzer
Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.

  • Constructor Details

    • PatternAnalyzer

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

    • areLowerCaseTerms

      public Boolean areLowerCaseTerms()
      Get the lowerCaseTerms property: A value indicating whether terms should be lower-cased. Default is true.
      Returns:
      the lowerCaseTerms value.

    • setLowerCaseTerms

      public PatternAnalyzer setLowerCaseTerms(Boolean lowerCaseTerms)
      Set the lowerCaseTerms property: A value indicating whether terms should be lower-cased. Default is true.
      Parameters:
      lowerCaseTerms - the lowerCaseTerms value to set.
      Returns:
      the PatternAnalyzer object itself.

    • 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 PatternAnalyzer 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 PatternAnalyzer object itself.

    • getFlags

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

    • setFlags

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

    • getStopwords

      public List<String> getStopwords()
      Get the stopwords property: A list of stopwords.
      Returns:
      the stopwords value.

    • setStopwords

      public PatternAnalyzer setStopwords(List<String> stopwords)
      Set the stopwords property: A list of stopwords.
      Parameters:
      stopwords - the stopwords value to set.
      Returns:
      the PatternAnalyzer 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 PatternAnalyzer fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PatternAnalyzer from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PatternAnalyzer 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 PatternAnalyzer.

    • setStopwords

      public PatternAnalyzer setStopwords(String... stopwords)
      Set the stopwords property: A list of stopwords.
      Parameters:
      stopwords - the stopwords value to set.
      Returns:
      the PatternAnalyzer object itself.

    • setFlags

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