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​(java.lang.String name, boolean useFilterForMultitermQueries, boolean useFilterForParsingSynonyms, java.util.function.BiFunction<org.apache.lucene.analysis.TokenStream,​Version,​org.apache.lucene.analysis.TokenStream> create)
    Create a pre-configured token filter that may vary based on the Elasticsearch version.
    static PreConfiguredTokenFilter elasticsearchVersion​(java.lang.String name, boolean useFilterForMultitermQueries, java.util.function.BiFunction<org.apache.lucene.analysis.TokenStream,​Version,​org.apache.lucene.analysis.TokenStream> create)
    Create a pre-configured token filter that may vary based on the Elasticsearch version.
    static PreConfiguredTokenFilter luceneVersion​(java.lang.String name, boolean useFilterForMultitermQueries, java.util.function.BiFunction<org.apache.lucene.analysis.TokenStream,​org.apache.lucene.util.Version,​org.apache.lucene.analysis.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​(java.lang.String name, boolean useFilterForMultitermQueries, boolean allowForSynonymParsing, java.util.function.Function<org.apache.lucene.analysis.TokenStream,​org.apache.lucene.analysis.TokenStream> create)
    Create a pre-configured token filter that may not vary at all.
    static PreConfiguredTokenFilter singleton​(java.lang.String name, boolean useFilterForMultitermQueries, java.util.function.Function<org.apache.lucene.analysis.TokenStream,​org.apache.lucene.analysis.TokenStream> create)
    Create a pre-configured token filter that may not vary at all.

    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 Details

    • singleton

      public static PreConfiguredTokenFilter singleton​(java.lang.String name, boolean useFilterForMultitermQueries, java.util.function.Function<org.apache.lucene.analysis.TokenStream,​org.apache.lucene.analysis.TokenStream> create)
      Create a pre-configured token filter that may not vary at all.

    • singleton

      public static PreConfiguredTokenFilter singleton​(java.lang.String name, boolean useFilterForMultitermQueries, boolean allowForSynonymParsing, java.util.function.Function<org.apache.lucene.analysis.TokenStream,​org.apache.lucene.analysis.TokenStream> create)
      Create a pre-configured token filter that may not vary at all.

    • luceneVersion

      public static PreConfiguredTokenFilter luceneVersion​(java.lang.String name, boolean useFilterForMultitermQueries, java.util.function.BiFunction<org.apache.lucene.analysis.TokenStream,​org.apache.lucene.util.Version,​org.apache.lucene.analysis.TokenStream> create)
      Create a pre-configured token filter that may vary based on the Lucene version.

    • elasticsearchVersion

      public static PreConfiguredTokenFilter elasticsearchVersion​(java.lang.String name, boolean useFilterForMultitermQueries, java.util.function.BiFunction<org.apache.lucene.analysis.TokenStream,​Version,​org.apache.lucene.analysis.TokenStream> create)
      Create a pre-configured token filter that may vary based on the Elasticsearch version.

    • elasticsearchVersion

      public static PreConfiguredTokenFilter elasticsearchVersion​(java.lang.String name, boolean useFilterForMultitermQueries, boolean useFilterForParsingSynonyms, java.util.function.BiFunction<org.apache.lucene.analysis.TokenStream,​Version,​org.apache.lucene.analysis.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>