org.apache.lucene.analysis.miscellaneous

Class SetKeywordMarkerFilter

java.lang.Object

org.apache.lucene.util.AttributeSource

org.apache.lucene.analysis.TokenStream

org.apache.lucene.analysis.TokenFilter

org.apache.lucene.analysis.miscellaneous.KeywordMarkerFilter

org.apache.lucene.analysis.miscellaneous.SetKeywordMarkerFilter

All Implemented Interfaces:

Closeable, AutoCloseable

public final class SetKeywordMarkerFilter
extends KeywordMarkerFilter

Marks terms as keywords via the KeywordAttribute. Each token contained in the provided set is marked as a keyword by setting KeywordAttribute.setKeyword(boolean) to true.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

AttributeSource.AttributeFactory, AttributeSource.State

Constructor Summary

Constructors

Constructor and Description
SetKeywordMarkerFilter(TokenStream in, CharArraySet keywordSet) Create a new KeywordSetMarkerFilter, that marks the current token as a keyword if the tokens term buffer is contained in the given set via the KeywordAttribute.

Method Summary

Methods inherited from class org.apache.lucene.analysis.miscellaneous.KeywordMarkerFilter

incrementToken

Methods inherited from class org.apache.lucene.analysis.TokenFilter

close, end, reset

Methods inherited from class org.apache.lucene.util.AttributeSource

addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, restoreState, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetKeywordMarkerFilter

public SetKeywordMarkerFilter(TokenStream in,
                              CharArraySet keywordSet)

Create a new KeywordSetMarkerFilter, that marks the current token as a keyword if the tokens term buffer is contained in the given set via the KeywordAttribute.

Parameters:

in - TokenStream to filter

keywordSet - the keywords set to lookup the current termbuffer