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

Class PatternReplaceTokenFilter

java.lang.Object

com.azure.search.documents.indexes.models.TokenFilter

com.azure.search.documents.indexes.models.PatternReplaceTokenFilter

public final class PatternReplaceTokenFilter
extends TokenFilter

A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text "aa bb aa bb", pattern "(aa)\s+(bb)", and replacement "$1#$2", the result would be "aa#bb aa#bb". This token filter is implemented using Apache Lucene.

Constructor Summary

Constructors

Constructor	Description
PatternReplaceTokenFilter(String name, String pattern, String replacement)	Constructor of PatternReplaceTokenFilter.

Method Summary

Modifier and Type	Method	Description
String	getPattern()	Get the pattern property: A regular expression pattern.
String	getReplacement()	Get the replacement property: The replacement text.

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 Details

PatternReplaceTokenFilter

public PatternReplaceTokenFilter(String name,
 String pattern,
 String replacement)

Constructor of PatternReplaceTokenFilter.

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.

pattern - A regular expression pattern.

replacement - The replacement text.

Method Details

getPattern

public String getPattern()

Get the pattern property: A regular expression pattern.

Returns:

the pattern value.

getReplacement

public String getReplacement()

Get the replacement property: The replacement text.

Returns:

the replacement value.