PatternCaptureTokenFilter Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.TokenFilter
  • • com.azure.search.documents.indexes.models.PatternCaptureTokenFilter

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 Summary

Constructor	Description
PatternCaptureTokenFilter(String name, List<String> patterns)	Creates an instance of PatternCaptureTokenFilter class.

Method Summary

Modifier and Type	Method and Description
static PatternCaptureTokenFilter	fromJson(JsonReader jsonReader) Reads an instance of PatternCaptureTokenFilter from the JsonReader.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of token filter.
List<String>	getPatterns() Get the patterns property: A list of patterns to match against each token.
Boolean	isPreserveOriginal() Get the preserveOriginal property: A value indicating whether to return the original token even if one of the patterns matches.
PatternCaptureTokenFilter	setPreserveOriginal(Boolean preserveOriginal) Set the preserveOriginal property: A value indicating whether to return the original token even if one of the patterns matches.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from TokenFilter

fromJson getName getOdataType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

fromJson

public static PatternCaptureTokenFilter fromJson(JsonReader jsonReader)

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:

IOException

- If the deserialized JSON object was missing any required properties.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of token filter.

Overrides:

PatternCaptureTokenFilter.getOdataType()

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 JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

PatternCaptureTokenFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException