Class KeepWordFilter
java.lang.Object
org.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.TokenFilter
org.apache.lucene.analysis.FilteringTokenFilter
org.apache.lucene.analysis.miscellaneous.KeepWordFilter
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Unwrappable<TokenStream>
A TokenFilter that only keeps tokens with text contained in the required words. This filter
behaves like the inverse of StopFilter.
- Since:
- solr 1.3
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.State
-
Field Summary
FieldsFields inherited from class org.apache.lucene.analysis.TokenFilter
input
Fields inherited from class org.apache.lucene.analysis.TokenStream
DEFAULT_TOKEN_ATTRIBUTE_FACTORY
-
Constructor Summary
ConstructorsConstructorDescriptionKeepWordFilter
(TokenStream in, CharArraySet words) Create a newKeepWordFilter
. -
Method Summary
Modifier and TypeMethodDescriptionboolean
accept()
Override this method and return if the current input token should be returned byFilteringTokenFilter.incrementToken()
.Methods inherited from class org.apache.lucene.analysis.FilteringTokenFilter
end, incrementToken, reset
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, unwrap
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
-
Field Details
-
words
-
termAtt
-
-
Constructor Details
-
KeepWordFilter
Create a newKeepWordFilter
.NOTE: The words set passed to this constructor will be directly used by this filter and should not be modified.
- Parameters:
in
- theTokenStream
to consumewords
- the words to keep
-
-
Method Details
-
accept
public boolean accept()Description copied from class:FilteringTokenFilter
Override this method and return if the current input token should be returned byFilteringTokenFilter.incrementToken()
.- Specified by:
accept
in classFilteringTokenFilter
-