Package org.opensearch.index.analysis

Class PreConfiguredAnalysisComponent<T>

java.lang.Object

org.opensearch.index.analysis.PreConfiguredAnalysisComponent<T>

All Implemented Interfaces:

AnalysisModule.AnalysisProvider<T>

Direct Known Subclasses:

PreBuiltAnalyzerProviderFactory, PreConfiguredCharFilter, PreConfiguredTokenFilter, PreConfiguredTokenizer

public abstract class PreConfiguredAnalysisComponent<T>
extends Object
implements AnalysisModule.AnalysisProvider<T>

Shared implementation for pre-configured analysis components.

Opensearch.internal:

Field Summary

Fields

Modifier and Type	Field	Description
protected final PreBuiltCacheFactory.PreBuiltCache<T>	cache
protected final String	name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PreConfiguredAnalysisComponent(String name, PreBuiltCacheFactory.CachingStrategy cache)
protected	PreConfiguredAnalysisComponent(String name, PreBuiltCacheFactory.PreBuiltCache<T> cache)

Method Summary

Modifier and Type	Method	Description
protected abstract T	create(org.opensearch.Version version)
T	get(IndexSettings indexSettings, Environment environment, String name, Settings settings)	Creates a new analysis provider.
String	getName()	The name of the analysis component in the API.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.indices.analysis.AnalysisModule.AnalysisProvider

get, requiresAnalysisSettings

Field Details

name

protected final String name

cache

protected final PreBuiltCacheFactory.PreBuiltCache<T> cache

Constructor Details

PreConfiguredAnalysisComponent

protected PreConfiguredAnalysisComponent(String name,
 PreBuiltCacheFactory.CachingStrategy cache)

PreConfiguredAnalysisComponent

protected PreConfiguredAnalysisComponent(String name,
 PreBuiltCacheFactory.PreBuiltCache<T> cache)

Method Details

get

public T get(IndexSettings indexSettings,
 Environment environment,
 String name,
 Settings settings)
      throws IOException

Description copied from interface: AnalysisModule.AnalysisProvider

Creates a new analysis provider.

Specified by:

get in interface AnalysisModule.AnalysisProvider<T>

Parameters:

indexSettings - the index settings for the index this provider is created for

environment - the nodes environment to load resources from persistent storage

name - the name of the analysis component

settings - the component specific settings without context prefixes

Returns:

a new provider instance

Throws:

IOException - if an IOException occurs

getName

public String getName()

The name of the analysis component in the API.

create

protected abstract T create(org.opensearch.Version version)