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

Class PatternCaptureTokenFilter

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

Constructors

Constructor	Description
PatternCaptureTokenFilter(String name, List<String> patterns)	Constructor of PatternCaptureTokenFilter.

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class com.azure.search.documents.indexes.models.TokenFilter

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PatternCaptureTokenFilter

public PatternCaptureTokenFilter(String name,
                                 List<String> patterns)

Constructor of PatternCaptureTokenFilter.

Parameters:

name - The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.

patterns - A list of patterns to match against each token.

Method Detail

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.