Module org.elasticsearch.server

Package org.elasticsearch.index.analysis

Interface IndexAnalyzers

All Superinterfaces:

AutoCloseable, Closeable

public interface IndexAnalyzers
extends Closeable

IndexAnalyzers contains a name to analyzer mapping for a specific index. This class only holds analyzers that are explicitly configured for an index and doesn't allow access to individual tokenizers, char or token filter.

See Also:

• AnalysisRegistry

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IndexAnalyzers.AnalyzerType

Method Summary

Modifier and Type	Method	Description
default void	close()
default NamedAnalyzer	get(String name)	Returns an analyzer mapped to the given name or null if not present
NamedAnalyzer	getAnalyzer(IndexAnalyzers.AnalyzerType type, String name)	Returns an analyzer of the given type mapped to the given name, or null if no such analyzer exists.
default NamedAnalyzer	getDefaultIndexAnalyzer()	Returns the default index analyzer for this index
default NamedAnalyzer	getDefaultSearchAnalyzer()	Returns the default search analyzer for this index.
default NamedAnalyzer	getDefaultSearchQuoteAnalyzer()	Returns the default search quote analyzer for this index.
default NamedAnalyzer	getNormalizer(String name)	Returns a normalizer mapped to the given name or null if not present
default NamedAnalyzer	getWhitespaceNormalizer(String name)	Returns a normalizer that splits on whitespace mapped to the given name or null if not present
static IndexAnalyzers	of(Map<String,NamedAnalyzer> analyzers)
static IndexAnalyzers	of(Map<String,NamedAnalyzer> analyzers, Map<String,NamedAnalyzer> tokenizers)
static IndexAnalyzers	of(Map<String,NamedAnalyzer> analyzers, Map<String,NamedAnalyzer> normalizers, Map<String,NamedAnalyzer> whitespaceNormalizers)
default List<String>	reload(AnalysisRegistry analysisRegistry, IndexSettings indexSettings)	Reload any analyzers that have reloadable components

Method Details

getAnalyzer

NamedAnalyzer getAnalyzer(IndexAnalyzers.AnalyzerType type,
 String name)

Returns an analyzer of the given type mapped to the given name, or null if no such analyzer exists.

get

default NamedAnalyzer get(String name)

Returns an analyzer mapped to the given name or null if not present

getNormalizer

default NamedAnalyzer getNormalizer(String name)

Returns a normalizer mapped to the given name or null if not present

getWhitespaceNormalizer

default NamedAnalyzer getWhitespaceNormalizer(String name)

Returns a normalizer that splits on whitespace mapped to the given name or null if not present

getDefaultIndexAnalyzer

default NamedAnalyzer getDefaultIndexAnalyzer()

Returns the default index analyzer for this index

getDefaultSearchAnalyzer

default NamedAnalyzer getDefaultSearchAnalyzer()

Returns the default search analyzer for this index. If not set, this will return the default analyzer

getDefaultSearchQuoteAnalyzer

default NamedAnalyzer getDefaultSearchQuoteAnalyzer()

Returns the default search quote analyzer for this index. If not set, this will return the default search analyzer

reload

default List<String> reload(AnalysisRegistry analysisRegistry,
 IndexSettings indexSettings)
                     throws IOException

Reload any analyzers that have reloadable components

Throws:

IOException

close

default void close()
            throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

of

static IndexAnalyzers of(Map<String,NamedAnalyzer> analyzers)

of

static IndexAnalyzers of(Map<String,NamedAnalyzer> analyzers,
 Map<String,NamedAnalyzer> tokenizers)

of

static IndexAnalyzers of(Map<String,NamedAnalyzer> analyzers,
 Map<String,NamedAnalyzer> normalizers,
 Map<String,NamedAnalyzer> whitespaceNormalizers)