/* * 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. */ /* * Licensed to Elasticsearch under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch 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. */ /* * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. */ package org.opensearch.index.analysis; import org.opensearch.common.settings.Settings; import java.util.ArrayList; import java.util.List; import java.util.Map; /** * A class that groups analysis components necessary to produce a custom analyzer. * See {@link ReloadableCustomAnalyzer} for an example usage. * * @opensearch.internal */ public final class AnalyzerComponents { private final TokenizerFactory tokenizerFactory; private final CharFilterFactory[] charFilters; private final TokenFilterFactory[] tokenFilters; private final AnalysisMode analysisMode; AnalyzerComponents(TokenizerFactory tokenizerFactory, CharFilterFactory[] charFilters, TokenFilterFactory[] tokenFilters) { this.tokenizerFactory = tokenizerFactory; this.charFilters = charFilters; this.tokenFilters = tokenFilters; AnalysisMode mode = AnalysisMode.ALL; for (TokenFilterFactory f : tokenFilters) { mode = mode.merge(f.getAnalysisMode()); } this.analysisMode = mode; } static AnalyzerComponents createComponents( String name, Settings analyzerSettings, final Map<String, TokenizerFactory> tokenizers, final Map<String, CharFilterFactory> charFilters, final Map<String, TokenFilterFactory> tokenFilters ) { String tokenizerName = analyzerSettings.get("tokenizer"); if (tokenizerName == null) { throw new IllegalArgumentException("Custom Analyzer [" + name + "] must be configured with a tokenizer"); } TokenizerFactory tokenizer = tokenizers.get(tokenizerName); if (tokenizer == null) { throw new IllegalArgumentException( "Custom Analyzer [" + name + "] failed to find tokenizer under name " + "[" + tokenizerName + "]" ); } List<String> charFilterNames = analyzerSettings.getAsList("char_filter"); List<CharFilterFactory> charFiltersList = new ArrayList<>(charFilterNames.size()); for (String charFilterName : charFilterNames) { CharFilterFactory charFilter = charFilters.get(charFilterName); if (charFilter == null) { throw new IllegalArgumentException( "Custom Analyzer [" + name + "] failed to find char_filter under name " + "[" + charFilterName + "]" ); } charFiltersList.add(charFilter); } List<String> tokenFilterNames = analyzerSettings.getAsList("filter"); List<TokenFilterFactory> tokenFilterList = new ArrayList<>(tokenFilterNames.size()); for (String tokenFilterName : tokenFilterNames) { TokenFilterFactory tokenFilter = tokenFilters.get(tokenFilterName); if (tokenFilter == null) { throw new IllegalArgumentException( "Custom Analyzer [" + name + "] failed to find filter under name " + "[" + tokenFilterName + "]" ); } tokenFilter = tokenFilter.getChainAwareTokenFilterFactory(tokenizer, charFiltersList, tokenFilterList, tokenFilters::get); tokenFilterList.add(tokenFilter); } return new AnalyzerComponents( tokenizer, charFiltersList.toArray(new CharFilterFactory[0]), tokenFilterList.toArray(new TokenFilterFactory[0]) ); } public TokenizerFactory getTokenizerFactory() { return tokenizerFactory; } public TokenFilterFactory[] getTokenFilters() { return tokenFilters; } public CharFilterFactory[] getCharFilters() { return charFilters; } public AnalysisMode analysisMode() { return this.analysisMode; } }