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.

Constructor Summary

Constructors

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

Method Summary

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

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

get, requiresAnalysisSettings

Methods inherited from class java.lang.Object

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

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

get, getName

Constructor Detail

PreConfiguredCharFilter

protected PreConfiguredCharFilter(java.lang.String name,
                                  PreBuiltCacheFactory.CachingStrategy cache,
                                  boolean useFilterForMultitermQueries,
                                  java.util.function.BiFunction<java.io.Reader,Version,java.io.Reader> create)

Method Detail

singleton

public static PreConfiguredCharFilter singleton(java.lang.String name,
                                                boolean useFilterForMultitermQueries,
                                                java.util.function.Function<java.io.Reader,java.io.Reader> create)

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

singletonWithVersion

public static PreConfiguredCharFilter singletonWithVersion(java.lang.String name,
                                                           boolean useFilterForMultitermQueries,
                                                           java.util.function.BiFunction<java.io.Reader,Version,java.io.Reader> create)

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

luceneVersion

public static PreConfiguredCharFilter luceneVersion(java.lang.String name,
                                                    boolean useFilterForMultitermQueries,
                                                    java.util.function.BiFunction<java.io.Reader,org.apache.lucene.util.Version,java.io.Reader> create)

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

elasticsearchVersion

public static PreConfiguredCharFilter elasticsearchVersion(java.lang.String name,
                                                           boolean useFilterForMultitermQueries,
                                                           java.util.function.BiFunction<java.io.Reader,Version,java.io.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>