org.elasticsearch.index.analysis

Class KeepWordFilterFactory

java.lang.Object

org.elasticsearch.index.AbstractIndexComponent

org.elasticsearch.index.analysis.AbstractTokenFilterFactory

org.elasticsearch.index.analysis.KeepWordFilterFactory

All Implemented Interfaces:

TokenFilterFactory, IndexComponent

@AnalysisSettingsRequired
public class KeepWordFilterFactory
extends AbstractTokenFilterFactory

A TokenFilterFactory for KeepWordFilter. This filter only keep tokens that are contained in the term set configured via setting. This filter acts like an inverse stop filter.

Configuration options:

• the array of words / tokens to keep.
• an reference to a file containing the words / tokens to keep. Note: this is an alternative to if both are set an exception will be thrown.
• true iff the filter should maintain position increments for dropped tokens. The default is true.
• to use case sensitive keep words. The default is false which corresponds to case-sensitive.

See Also:

StopTokenFilterFactory

Field Summary

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

version

Fields inherited from class org.elasticsearch.index.AbstractIndexComponent

componentSettings, index, indexSettings, logger

Constructor Summary

Constructors

Constructor and Description
KeepWordFilterFactory(Index index, Settings indexSettings, Environment env, String name, Settings settings)

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.analysis.TokenStream	create(org.apache.lucene.analysis.TokenStream tokenStream)

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

name, version

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

Constructor Detail

KeepWordFilterFactory

@Inject
public KeepWordFilterFactory(Index index,
                                     @IndexSettings
                                     Settings indexSettings,
                                     Environment env,
                                     String name,
                                     Settings settings)

Method Detail

create

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