Class PatternCaptureTokenFilter

java.lang.Object
com.azure.search.documents.indexes.models.TokenFilter
com.azure.search.documents.indexes.models.PatternCaptureTokenFilter
All Implemented Interfaces:
com.azure.json.JsonSerializable<TokenFilter>
public final class PatternCaptureTokenFilter extends TokenFilter
Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.

  • Constructor Details

    • PatternCaptureTokenFilter

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

    • getPatterns

      public List<String> getPatterns()
      Get the patterns property: A list of patterns to match against each token.
      Returns:
      the patterns value.

    • isPreserveOriginal

      public Boolean isPreserveOriginal()
      Get the preserveOriginal property: A value indicating whether to return the original token even if one of the patterns matches. Default is true.
      Returns:
      the preserveOriginal value.

    • setPreserveOriginal

      public PatternCaptureTokenFilter setPreserveOriginal(Boolean preserveOriginal)
      Set the preserveOriginal property: A value indicating whether to return the original token even if one of the patterns matches. Default is true.
      Parameters:
      preserveOriginal - the preserveOriginal value to set.
      Returns:
      the PatternCaptureTokenFilter 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 PatternCaptureTokenFilter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PatternCaptureTokenFilter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PatternCaptureTokenFilter 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 PatternCaptureTokenFilter.