Allow plugins to build "pre-configured" token filters #24223
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.elasticsearch.index.analysis; | ||
|
|
||
| import org.apache.lucene.analysis.TokenFilter; | ||
| import org.apache.lucene.analysis.TokenStream; | ||
| import org.elasticsearch.Version; | ||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.env.Environment; | ||
| import org.elasticsearch.index.IndexSettings; | ||
| import org.elasticsearch.indices.analysis.AnalysisModule; | ||
| import org.elasticsearch.indices.analysis.PreBuiltCacheFactory; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.function.BiFunction; | ||
| import java.util.function.Function; | ||
|
|
||
| /** | ||
| * Provides pre-configured, shared {@link TokenFilter}s. | ||
| */ | ||
| public final class PreConfiguredTokenFilter implements AnalysisModule.AnalysisProvider<TokenFilterFactory> { | ||
| private final String name; | ||
| private final boolean useFilterForMultitermQueries; | ||
| private final PreBuiltCacheFactory.PreBuiltCache<TokenFilterFactory> cache; | ||
| private final BiFunction<TokenStream, Version, TokenStream> create; | ||
|
|
||
| /** | ||
| * Standard ctor with all the power. | ||
| */ | ||
| public PreConfiguredTokenFilter(String name, boolean useFilterForMultitermQueries, | ||
| PreBuiltCacheFactory.CachingStrategy cachingStrategy, BiFunction<TokenStream, Version, TokenStream> create) { | ||
| this.name = name; | ||
| this.useFilterForMultitermQueries = useFilterForMultitermQueries; | ||
| cache = PreBuiltCacheFactory.getCache(cachingStrategy); | ||
| this.create = create; | ||
| } | ||
|
|
||
| /** | ||
| * Convenience ctor for token streams that don't vary based on version. | ||
| */ | ||
| public PreConfiguredTokenFilter(String name, boolean useFilterForMultitermQueries, | ||
| PreBuiltCacheFactory.CachingStrategy cachingStrategy, Function<TokenStream, TokenStream> create) { | ||
| this(name, useFilterForMultitermQueries, cachingStrategy, (input, version) -> create.apply(input)); | ||
| // TODO why oh why aren't these all CachingStrategy.ONE? They *can't* vary based on version because they don't get it, right?! | ||
|
Contributor
There was a problem hiding this comment. Sounds correct to me, let's hardcode CachingStrategy.ONE?
Member
Author
There was a problem hiding this comment. I'd been thinking of doing it in a follow. Any objections?
Contributor
There was a problem hiding this comment. not at all, this PR is large already |
||
| } | ||
|
|
||
| @Override | ||
| public TokenFilterFactory get(IndexSettings indexSettings, Environment environment, String name, Settings settings) throws IOException { | ||
| return getTokenFilterFactory(Version.indexCreated(settings)); | ||
| } | ||
|
|
||
| /** | ||
| * The name of the {@link TokenFilter} in the API. | ||
| */ | ||
| public String getName() { | ||
| return name; | ||
| } | ||
|
|
||
| /** | ||
| * Can this {@link TokenFilter} be used in multi-term queries? | ||
| */ | ||
| public boolean shouldUseFilterForMultitermQueries() { | ||
| return useFilterForMultitermQueries; | ||
| } | ||
|
|
||
| private interface MultiTermAwareTokenFilterFactory extends TokenFilterFactory, MultiTermAwareComponent {} | ||
|
|
||
| private synchronized TokenFilterFactory getTokenFilterFactory(final Version version) { | ||
| TokenFilterFactory factory = cache.get(version); | ||
| if (factory == null) { | ||
| if (useFilterForMultitermQueries) { | ||
| factory = new MultiTermAwareTokenFilterFactory() { | ||
| @Override | ||
| public String name() { | ||
| return name; | ||
| } | ||
|
|
||
| @Override | ||
| public TokenStream create(TokenStream tokenStream) { | ||
| return create.apply(tokenStream, version); | ||
| } | ||
|
|
||
| @Override | ||
| public Object getMultiTermComponent() { | ||
| return this; | ||
| } | ||
| }; | ||
| } else { | ||
| factory = new TokenFilterFactory() { | ||
| @Override | ||
| public String name() { | ||
| return name; | ||
| } | ||
|
|
||
| @Override | ||
| public TokenStream create(TokenStream tokenStream) { | ||
| return create.apply(tokenStream, version); | ||
| } | ||
| }; | ||
| } | ||
| cache.put(version, factory); | ||
| } | ||
|
|
||
| return factory; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe later (followup, as cleanup after these are all done) these members could be renamed to
preConfigured*