/* SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. */ /* * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. * * Licensed to Elasticsearch B.V. under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch B.V. licenses this file to you under * the Apache License, Version 2.0 (the "License"); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ using System; using System.Collections.Generic; using OpenSearch.Net.Utf8Json; namespace OpenSearch.Client { [JsonFormatter(typeof(VerbatimDictionaryKeysFormatter))] public interface ICharFilters : IIsADictionary { } public class CharFilters : IsADictionaryBase, ICharFilters { public CharFilters() { } public CharFilters(IDictionary container) : base(container) { } public CharFilters(Dictionary container) : base(container) { } public void Add(string name, ICharFilter analyzer) => BackingDictionary.Add(name, analyzer); } public class CharFiltersDescriptor : IsADictionaryDescriptorBase { public CharFiltersDescriptor() : base(new CharFilters()) { } public CharFiltersDescriptor UserDefined(string name, ICharFilter analyzer) => Assign(name, analyzer); /// /// The pattern_replace char filter allows the use of a regex to manipulate the characters in a string before analysis. /// public CharFiltersDescriptor PatternReplace(string name, Func selector) => Assign(name, selector?.Invoke(new PatternReplaceCharFilterDescriptor())); /// /// A char filter of type html_strip stripping out HTML elements from an analyzed text. /// public CharFiltersDescriptor HtmlStrip(string name, Func selector = null) => Assign(name, selector.InvokeOrDefault(new HtmlStripCharFilterDescriptor())); /// /// A char filter of type mapping replacing characters of an analyzed text with given mapping. /// public CharFiltersDescriptor Mapping(string name, Func selector) => Assign(name, selector?.Invoke(new MappingCharFilterDescriptor())); /// /// The kuromoji_iteration_mark normalizes Japanese horizontal iteration marks (odoriji) to their expanded form. /// Part of the `analysis-kuromoji` plugin: /// /// public CharFiltersDescriptor KuromojiIterationMark(string name, Func selector = null ) => Assign(name, selector?.InvokeOrDefault(new KuromojiIterationMarkCharFilterDescriptor())); /// /// Normalizes as defined here: http://userguide.icu-project.org/transforms/normalization /// Part of the `analysis-icu` plugin: /// public CharFiltersDescriptor IcuNormalization(string name, Func selector ) => Assign(name, selector?.Invoke(new IcuNormalizationCharFilterDescriptor())); } }