-
Notifications
You must be signed in to change notification settings - Fork 24.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Allow plugins to build pre-configured token filters (#24223)
This changes the way we register pre-configured token filters so that plugins can declare them and starts to move all of the pre-configured token filters out of core. It doesn't finish the job because doing so would make the change unreviewably large. So this PR includes a shim that keeps the "old" way of registering pre-configured token filters around. The Lowercase token filter is special because there is a "special" interaction between it and the lowercase tokenizer. I'm not sure exactly what to do about it so for now I'm leaving it alone with the intent of figuring out what to do with it in a followup. This also renames these pre-configured token filters from "pre-built" to "pre-configured" because that seemed like a more descriptive name. This is a part of #23658
- Loading branch information
Showing
23 changed files
with
579 additions
and
427 deletions.
There are no files selected for viewing
This file contains 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
50 changes: 0 additions & 50 deletions
50
core/src/main/java/org/elasticsearch/index/analysis/PreBuiltTokenFilterFactoryFactory.java
This file was deleted.
Oops, something went wrong.
123 changes: 123 additions & 0 deletions
123
core/src/main/java/org/elasticsearch/index/analysis/PreConfiguredTokenFilter.java
This file contains 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?! | ||
| } | ||
|
|
||
| @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 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 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.