org.elasticsearch.index.analysis
Class IcuCollationTokenFilterFactory

java.lang.Object
  org.elasticsearch.index.AbstractIndexComponent
      org.elasticsearch.index.analysis.AbstractTokenFilterFactory
          org.elasticsearch.index.analysis.IcuCollationTokenFilterFactory

All Implemented Interfaces:

org.elasticsearch.index.analysis.TokenFilterFactory, org.elasticsearch.index.IndexComponent

public class IcuCollationTokenFilterFactory
extends org.elasticsearch.index.analysis.AbstractTokenFilterFactory

An ICU based collation token filter. There are two ways to configure collation:

The first is simply specifying the locale (defaults to the default locale). The language parameter is the lowercase two-letter ISO-639 code. An additional country and variant can be provided.

The second option is to specify collation rules as defined in the Collation customization chapter in icu docs. The rules parameter can either embed the rules definition in the settings or refer to an external location (preferable located under the config location, relative to it).

Field Summary

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

componentSettings, index, indexSettings, logger

Constructor Summary

IcuCollationTokenFilterFactory(org.elasticsearch.index.Index index, org.elasticsearch.common.settings.Settings indexSettings, org.elasticsearch.env.Environment environment, java.lang.String name, org.elasticsearch.common.settings.Settings settings)

Method Summary

org.apache.lucene.analysis.TokenStream

create(org.apache.lucene.analysis.TokenStream tokenStream)

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

name

Methods inherited from class org.elasticsearch.index.AbstractIndexComponent

index, nodeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.IndexComponent

index

Constructor Detail

IcuCollationTokenFilterFactory

@Inject
public IcuCollationTokenFilterFactory(org.elasticsearch.index.Index index,
                                             @IndexSettings
                                             org.elasticsearch.common.settings.Settings indexSettings,
                                             org.elasticsearch.env.Environment environment,
                                             java.lang.String name,
                                             org.elasticsearch.common.settings.Settings settings)

Method Detail

create

public org.apache.lucene.analysis.TokenStream create(org.apache.lucene.analysis.TokenStream tokenStream)