Package org.elasticsearch.index.analysis

Class PreConfiguredCharFilter

java.lang.Object

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

org.elasticsearch.index.analysis.PreConfiguredCharFilter

All Implemented Interfaces:

AnalysisModule.AnalysisProvider<CharFilterFactory>

public class PreConfiguredCharFilter
extends PreConfiguredAnalysisComponent<CharFilterFactory>

Provides pre-configured, shared CharFilters.

Field Summary

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

cache, name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PreConfiguredCharFilter(String name, PreBuiltCacheFactory.CachingStrategy cache, boolean useFilterForMultitermQueries, BiFunction<Reader,Version,Reader> create)

Method Summary

Modifier and Type	Method	Description
protected CharFilterFactory	create(Version version)
static PreConfiguredCharFilter	elasticsearchVersion(String name, boolean useFilterForMultitermQueries, BiFunction<Reader,Version,Reader> create)	Create a pre-configured token filter that may vary based on the Elasticsearch version.
static PreConfiguredCharFilter	luceneVersion(String name, boolean useFilterForMultitermQueries, BiFunction<Reader,Version,Reader> 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 PreConfiguredCharFilter	singleton(String name, boolean useFilterForMultitermQueries, Function<Reader,Reader> create)	Create a pre-configured char filter that may not vary at all.
static PreConfiguredCharFilter	singletonWithVersion(String name, boolean useFilterForMultitermQueries, BiFunction<Reader,Version,Reader> create)	Create a pre-configured char filter that may not vary at all, provide access to 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

Constructor Detail

PreConfiguredCharFilter

protected PreConfiguredCharFilter(String name,
                                  PreBuiltCacheFactory.CachingStrategy cache,
                                  boolean useFilterForMultitermQueries,
                                  BiFunction<Reader,Version,Reader> create)

Method Detail

singleton

public static PreConfiguredCharFilter singleton(String name,
                                                boolean useFilterForMultitermQueries,
                                                Function<Reader,Reader> create)

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

singletonWithVersion

public static PreConfiguredCharFilter singletonWithVersion(String name,
                                                           boolean useFilterForMultitermQueries,
                                                           BiFunction<Reader,Version,Reader> create)

Create a pre-configured char filter that may not vary at all, provide access to the elasticsearch version

luceneVersion

public static PreConfiguredCharFilter luceneVersion(String name,
                                                    boolean useFilterForMultitermQueries,
                                                    BiFunction<Reader,Version,Reader> create)

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

elasticsearchVersion

public static PreConfiguredCharFilter elasticsearchVersion(String name,
                                                           boolean useFilterForMultitermQueries,
                                                           BiFunction<Reader,Version,Reader> 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 CharFilterFactory create(Version version)

Specified by:

create in class PreConfiguredAnalysisComponent<CharFilterFactory>