Share via


PatternReplaceCharFilter Class

Definition

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.

public class PatternReplaceCharFilter : Azure.Search.Documents.Indexes.Models.CharFilter
public class PatternReplaceCharFilter : Azure.Search.Documents.Indexes.Models.CharFilter, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.PatternReplaceCharFilter>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.PatternReplaceCharFilter>
type PatternReplaceCharFilter = class
    inherit CharFilter
type PatternReplaceCharFilter = class
    inherit CharFilter
    interface IJsonModel<PatternReplaceCharFilter>
    interface IPersistableModel<PatternReplaceCharFilter>
Public Class PatternReplaceCharFilter
Inherits CharFilter
Public Class PatternReplaceCharFilter
Inherits CharFilter
Implements IJsonModel(Of PatternReplaceCharFilter), IPersistableModel(Of PatternReplaceCharFilter)
Inheritance
PatternReplaceCharFilter
Implements

Constructors

PatternReplaceCharFilter(String, String, String)

Initializes a new instance of PatternReplaceCharFilter.

Properties

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.

(Inherited from CharFilter)
Pattern

A regular expression pattern.

Replacement

The replacement text.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CharFilter>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from CharFilter)
IJsonModel<CharFilter>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from CharFilter)
IJsonModel<PatternReplaceCharFilter>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<PatternReplaceCharFilter>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CharFilter>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from CharFilter)
IPersistableModel<CharFilter>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from CharFilter)
IPersistableModel<CharFilter>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from CharFilter)
IPersistableModel<PatternReplaceCharFilter>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<PatternReplaceCharFilter>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<PatternReplaceCharFilter>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to