Package org.opensearch.index.analysis

Class AnalysisRegistry

java.lang.Object

org.opensearch.index.analysis.AnalysisRegistry

All Implemented Interfaces:

Closeable, AutoCloseable

@PublicApi(since="1.0.0")
public final class AnalysisRegistry
extends Object
implements Closeable

An internal registry for tokenizer, token filter, char filter and analyzer. This class exists per node and allows to create per-index IndexAnalyzers via build(IndexSettings)

Opensearch.api:

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ANALYZER_NAME
static final String	DEFAULT_SEARCH_ANALYZER_NAME
static final String	DEFAULT_SEARCH_QUOTED_ANALYZER_NAME
static final String	INDEX_ANALYSIS_CHAR_FILTER
static final String	INDEX_ANALYSIS_FILTER
static final String	INDEX_ANALYSIS_TOKENIZER

Constructor Summary

Constructors

Constructor

Description

AnalysisRegistry(Environment environment, Map<String,AnalysisModule.AnalysisProvider<CharFilterFactory>> charFilters, Map<String,AnalysisModule.AnalysisProvider<TokenFilterFactory>> tokenFilters, Map<String,AnalysisModule.AnalysisProvider<TokenizerFactory>> tokenizers, Map<String,AnalysisModule.AnalysisProvider<AnalyzerProvider<?>>> analyzers, Map<String,AnalysisModule.AnalysisProvider<AnalyzerProvider<?>>> normalizers, Map<String,PreConfiguredCharFilter> preConfiguredCharFilters, Map<String,PreConfiguredTokenFilter> preConfiguredTokenFilters, Map<String,PreConfiguredTokenizer> preConfiguredTokenizers, Map<String,PreBuiltAnalyzerProviderFactory> preConfiguredAnalyzers)

Method Summary

Modifier and Type	Method	Description
IndexAnalyzers	build(IndexSettings indexSettings)	Creates an index-level IndexAnalyzers from this registry using the given index settings
IndexAnalyzers	build(IndexSettings indexSettings, Map<String,AnalyzerProvider<?>> analyzerProviders, Map<String,AnalyzerProvider<?>> normalizerProviders, Map<String,TokenizerFactory> tokenizerFactoryFactories, Map<String,CharFilterFactory> charFilterFactoryFactories, Map<String,TokenFilterFactory> tokenFilterFactoryFactories)
Map<String,CharFilterFactory>	buildCharFilterFactories(IndexSettings indexSettings)
NamedAnalyzer	buildCustomAnalyzer(IndexSettings indexSettings, boolean normalizer, NameOrDefinition tokenizer, List<NameOrDefinition> charFilters, List<NameOrDefinition> tokenFilters)	Creates a custom analyzer from a collection of NameOrDefinition specifications for each component
Map<String,TokenFilterFactory>	buildTokenFilterFactories(IndexSettings indexSettings)
Map<String,TokenizerFactory>	buildTokenizerFactories(IndexSettings indexSettings)
void	close()
org.apache.lucene.analysis.Analyzer	getAnalyzer(String analyzer)	Returns a registered Analyzer provider by name or null if the analyzer was not registered

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INDEX_ANALYSIS_CHAR_FILTER

public static final String INDEX_ANALYSIS_CHAR_FILTER

See Also:

• Constant Field Values

INDEX_ANALYSIS_FILTER

public static final String INDEX_ANALYSIS_FILTER

See Also:

• Constant Field Values

INDEX_ANALYSIS_TOKENIZER

public static final String INDEX_ANALYSIS_TOKENIZER

See Also:

• Constant Field Values

DEFAULT_ANALYZER_NAME

public static final String DEFAULT_ANALYZER_NAME

See Also:

• Constant Field Values

DEFAULT_SEARCH_ANALYZER_NAME

public static final String DEFAULT_SEARCH_ANALYZER_NAME

See Also:

• Constant Field Values

DEFAULT_SEARCH_QUOTED_ANALYZER_NAME

public static final String DEFAULT_SEARCH_QUOTED_ANALYZER_NAME

See Also:

• Constant Field Values

Constructor Details

AnalysisRegistry

public AnalysisRegistry(Environment environment,
 Map<String,AnalysisModule.AnalysisProvider<CharFilterFactory>> charFilters,
 Map<String,AnalysisModule.AnalysisProvider<TokenFilterFactory>> tokenFilters,
 Map<String,AnalysisModule.AnalysisProvider<TokenizerFactory>> tokenizers,
 Map<String,AnalysisModule.AnalysisProvider<AnalyzerProvider<?>>> analyzers,
 Map<String,AnalysisModule.AnalysisProvider<AnalyzerProvider<?>>> normalizers,
 Map<String,PreConfiguredCharFilter> preConfiguredCharFilters,
 Map<String,PreConfiguredTokenFilter> preConfiguredTokenFilters,
 Map<String,PreConfiguredTokenizer> preConfiguredTokenizers,
 Map<String,PreBuiltAnalyzerProviderFactory> preConfiguredAnalyzers)

Method Details

getAnalyzer

public org.apache.lucene.analysis.Analyzer getAnalyzer(String analyzer)
                                                throws IOException

Returns a registered Analyzer provider by name or null if the analyzer was not registered

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

build

public IndexAnalyzers build(IndexSettings indexSettings)
                     throws IOException

Creates an index-level IndexAnalyzers from this registry using the given index settings

Throws:

IOException

buildCustomAnalyzer

public NamedAnalyzer buildCustomAnalyzer(IndexSettings indexSettings,
 boolean normalizer,
 NameOrDefinition tokenizer,
 List<NameOrDefinition> charFilters,
 List<NameOrDefinition> tokenFilters)
                                  throws IOException

Creates a custom analyzer from a collection of NameOrDefinition specifications for each component

Callers are responsible for closing the returned Analyzer

Throws:

IOException

buildTokenFilterFactories

public Map<String,TokenFilterFactory> buildTokenFilterFactories(IndexSettings indexSettings)
                                                         throws IOException

Throws:

IOException

buildTokenizerFactories

public Map<String,TokenizerFactory> buildTokenizerFactories(IndexSettings indexSettings)
                                                     throws IOException

Throws:

IOException

buildCharFilterFactories

public Map<String,CharFilterFactory> buildCharFilterFactories(IndexSettings indexSettings)
                                                       throws IOException

Throws:

IOException

build

public IndexAnalyzers build(IndexSettings indexSettings,
 Map<String,AnalyzerProvider<?>> analyzerProviders,
 Map<String,AnalyzerProvider<?>> normalizerProviders,
 Map<String,TokenizerFactory> tokenizerFactoryFactories,
 Map<String,CharFilterFactory> charFilterFactoryFactories,
 Map<String,TokenFilterFactory> tokenFilterFactoryFactories)