com.azure.search.documents.indexes.models

Class PatternReplaceCharFilter

java.lang.Object

com.azure.search.documents.indexes.models.CharFilter

com.azure.search.documents.indexes.models.PatternReplaceCharFilter

public final class PatternReplaceCharFilter
extends CharFilter

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 character filter is implemented using Apache Lucene.

Constructor Summary

Constructors

Constructor and Description
PatternReplaceCharFilter(String name, String pattern, String replacement) Constructor of CharFilter.

Method Summary

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

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternReplaceCharFilter

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

Constructor of CharFilter.

Parameters:

name - The name of the char 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 Detail

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.