Module org.elasticsearch.server

Package org.elasticsearch.plugins

Interface AnalysisPlugin

public interface AnalysisPlugin

An additional extension point for Plugins that extends Elasticsearch's analysis functionality. To add an additional TokenFilter just implement the interface and implement the getTokenFilters() method:

 public class AnalysisPhoneticPlugin extends Plugin implements AnalysisPlugin {
     @Override
     public Map<String, AnalysisProvider<TokenFilterFactory>> getTokenFilters() {
         return singletonMap("phonetic", PhoneticTokenFilterFactory::new);
     }
 }
 

Elasticsearch doesn't have any automatic mechanism to share these components between indexes. If any component is heavy enough to warrant such sharing then it is the Plugin's responsibility to do it in their AnalysisModule.AnalysisProvider implementation. We recommend against doing this unless absolutely necessary because it can be difficult to get the caching right given things like behavior changes across versions.

Method Summary

Modifier and Type	Method	Description
default Map<String,AnalysisModule.AnalysisProvider<AnalyzerProvider<? extends org.apache.lucene.analysis.Analyzer>>>	getAnalyzers()	Override to add additional Analyzers.
default Map<String,AnalysisModule.AnalysisProvider<CharFilterFactory>>	getCharFilters()	Override to add additional CharFilters.
default Map<String,org.apache.lucene.analysis.hunspell.Dictionary>	getHunspellDictionaries()	Override to add additional hunspell Dictionarys.
default List<PreBuiltAnalyzerProviderFactory>	getPreBuiltAnalyzerProviderFactories()	Override to add additional pre-configured Analyzers.
default List<PreConfiguredCharFilter>	getPreConfiguredCharFilters()	Override to add additional pre-configured CharFilters.
default List<PreConfiguredTokenFilter>	getPreConfiguredTokenFilters()	Override to add additional pre-configured TokenFilters.
default List<PreConfiguredTokenizer>	getPreConfiguredTokenizers()	Override to add additional pre-configured Tokenizer.
default Map<String,AnalysisModule.AnalysisProvider<TokenFilterFactory>>	getTokenFilters()	Override to add additional TokenFilters.
default Map<String,AnalysisModule.AnalysisProvider<TokenizerFactory>>	getTokenizers()	Override to add additional Tokenizers.
static <T> AnalysisModule.AnalysisProvider<T>	requiresAnalysisSettings(AnalysisModule.AnalysisProvider<T> provider)	Mark an AnalysisModule.AnalysisProvider as requiring the index's settings.

Method Details

getCharFilters

default Map<String,AnalysisModule.AnalysisProvider<CharFilterFactory>> getCharFilters()

Override to add additional CharFilters. See requiresAnalysisSettings(AnalysisProvider) how to on get the configuration from the index.

getTokenFilters

default Map<String,AnalysisModule.AnalysisProvider<TokenFilterFactory>> getTokenFilters()

Override to add additional TokenFilters. See requiresAnalysisSettings(AnalysisProvider) how to on get the configuration from the index.

getTokenizers

default Map<String,AnalysisModule.AnalysisProvider<TokenizerFactory>> getTokenizers()

Override to add additional Tokenizers. See requiresAnalysisSettings(AnalysisProvider) how to on get the configuration from the index.

getAnalyzers

default Map<String,AnalysisModule.AnalysisProvider<AnalyzerProvider<? extends org.apache.lucene.analysis.Analyzer>>> getAnalyzers()

Override to add additional Analyzers. See requiresAnalysisSettings(AnalysisProvider) how to on get the configuration from the index.

getPreBuiltAnalyzerProviderFactories

default List<PreBuiltAnalyzerProviderFactory> getPreBuiltAnalyzerProviderFactories()

Override to add additional pre-configured Analyzers.

getPreConfiguredCharFilters

default List<PreConfiguredCharFilter> getPreConfiguredCharFilters()

Override to add additional pre-configured CharFilters.

getPreConfiguredTokenFilters

default List<PreConfiguredTokenFilter> getPreConfiguredTokenFilters()

Override to add additional pre-configured TokenFilters.

getPreConfiguredTokenizers

default List<PreConfiguredTokenizer> getPreConfiguredTokenizers()

Override to add additional pre-configured Tokenizer.

getHunspellDictionaries

default Map<String,org.apache.lucene.analysis.hunspell.Dictionary> getHunspellDictionaries()

Override to add additional hunspell Dictionarys.

requiresAnalysisSettings

static <T> AnalysisModule.AnalysisProvider<T> requiresAnalysisSettings(AnalysisModule.AnalysisProvider<T> provider)

Mark an AnalysisModule.AnalysisProvider as requiring the index's settings.