Package org.apache.lucene.analysis.miscellaneous

Class PatternKeywordMarkerFilter

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.PatternKeywordMarkerFilter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class PatternKeywordMarkerFilter
extends KeywordMarkerFilter

Marks terms as keywords via the KeywordAttribute. Each token that matches the provided pattern 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	Description
PatternKeywordMarkerFilter(TokenStream in, java.util.regex.Pattern pattern)	Create a new PatternKeywordMarkerFilter, that marks the current token as a keyword if the tokens term buffer matches the provided Pattern 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

PatternKeywordMarkerFilter

public PatternKeywordMarkerFilter(TokenStream in,
                                  java.util.regex.Pattern pattern)

Create a new PatternKeywordMarkerFilter, that marks the current token as a keyword if the tokens term buffer matches the provided Pattern via the KeywordAttribute.

Parameters:

in - TokenStream to filter

pattern - the pattern to apply to the incoming term buffer