Package org.elasticsearch.index.analysis

Class PreConfiguredTokenFilter

java.lang.Object

org.elasticsearch.index.analysis.PreConfiguredAnalysisComponent<TokenFilterFactory>

org.elasticsearch.index.analysis.PreConfiguredTokenFilter

All Implemented Interfaces:

AnalysisModule.AnalysisProvider<TokenFilterFactory>

public final class PreConfiguredTokenFilter
extends PreConfiguredAnalysisComponent<TokenFilterFactory>

Provides pre-configured, shared TokenFilters.

Field Summary

Fields inherited from class org.elasticsearch.index.analysis.PreConfiguredAnalysisComponent

cache, name

Method Summary

Modifier and Type	Method	Description
protected TokenFilterFactory	create(Version version)
static PreConfiguredTokenFilter	elasticsearchVersion(String name, boolean useFilterForMultitermQueries, BiFunction<TokenStream,Version,TokenStream> create)	Create a pre-configured token filter that may vary based on the Elasticsearch version.
static PreConfiguredTokenFilter	luceneVersion(String name, boolean useFilterForMultitermQueries, BiFunction<TokenStream,Version,TokenStream> create)	Create a pre-configured token filter that may vary based on the Lucene version.
boolean	shouldUseFilterForMultitermQueries()	Can this TokenFilter be used in multi-term queries?
static PreConfiguredTokenFilter	singleton(String name, boolean useFilterForMultitermQueries, boolean allowForSynonymParsing, Function<TokenStream,TokenStream> create)	Create a pre-configured token filter that may not vary at all.
static PreConfiguredTokenFilter	singleton(String name, boolean useFilterForMultitermQueries, Function<TokenStream,TokenStream> create)	Create a pre-configured token filter that may not vary at all.
static PreConfiguredTokenFilter	singletonWithVersion(String name, boolean useFilterForMultitermQueries, boolean useFilterForParsingSynonyms, BiFunction<TokenStream,Version,TokenStream> create)	Create a pre-configured token filter that may vary based on the Elasticsearch version.
static PreConfiguredTokenFilter	singletonWithVersion(String name, boolean useFilterForMultitermQueries, BiFunction<TokenStream,Version,TokenStream> create)	Create a pre-configured token filter that may vary based on the Elasticsearch version.

Methods inherited from class org.elasticsearch.index.analysis.PreConfiguredAnalysisComponent

get, getName

Methods inherited from class java.lang.Object

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

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

get, requiresAnalysisSettings

Method Detail

singleton

public static PreConfiguredTokenFilter singleton(String name,
                                                 boolean useFilterForMultitermQueries,
                                                 Function<TokenStream,TokenStream> create)

Create a pre-configured token filter that may not vary at all.

singleton

public static PreConfiguredTokenFilter singleton(String name,
                                                 boolean useFilterForMultitermQueries,
                                                 boolean allowForSynonymParsing,
                                                 Function<TokenStream,TokenStream> create)

Create a pre-configured token filter that may not vary at all.

singletonWithVersion

public static PreConfiguredTokenFilter singletonWithVersion(String name,
                                                            boolean useFilterForMultitermQueries,
                                                            BiFunction<TokenStream,Version,TokenStream> create)

Create a pre-configured token filter that may vary based on the Elasticsearch version.

singletonWithVersion

public static PreConfiguredTokenFilter singletonWithVersion(String name,
                                                            boolean useFilterForMultitermQueries,
                                                            boolean useFilterForParsingSynonyms,
                                                            BiFunction<TokenStream,Version,TokenStream> create)

Create a pre-configured token filter that may vary based on the Elasticsearch version.

luceneVersion

public static PreConfiguredTokenFilter luceneVersion(String name,
                                                     boolean useFilterForMultitermQueries,
                                                     BiFunction<TokenStream,Version,TokenStream> create)

Create a pre-configured token filter that may vary based on the Lucene version.

elasticsearchVersion

public static PreConfiguredTokenFilter elasticsearchVersion(String name,
                                                            boolean useFilterForMultitermQueries,
                                                            BiFunction<TokenStream,Version,TokenStream> create)

Create a pre-configured token filter that may vary based on the Elasticsearch version.

shouldUseFilterForMultitermQueries

public boolean shouldUseFilterForMultitermQueries()

Can this TokenFilter be used in multi-term queries?

create

protected TokenFilterFactory create(Version version)

Specified by:

create in class PreConfiguredAnalysisComponent<TokenFilterFactory>