org.apache.solr.analysis
Class KeepWordFilter

java.lang.Object
  extended by org.apache.lucene.util.AttributeSource
      extended by org.apache.lucene.analysis.TokenStream
          extended by org.apache.lucene.analysis.TokenFilter
              extended by org.apache.lucene.analysis.FilteringTokenFilter
                  extended by org.apache.solr.analysis.KeepWordFilter
All Implemented Interfaces:
Closeable

public final class KeepWordFilter
extends FilteringTokenFilter

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
Version:
$Id: KeepWordFilter.java 1065324 2011-01-30 17:20:39Z uschindler $

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.AttributeFactory, AttributeSource.State
 
Field Summary
 
Fields inherited from class org.apache.lucene.analysis.TokenFilter
input
 
Constructor Summary
KeepWordFilter(boolean enablePositionIncrements, TokenStream in, CharArraySet words)
          The words set passed to this constructor will be directly used by this filter and should not be modified,
KeepWordFilter(TokenStream in, Set<String> words, boolean ignoreCase)
          Deprecated. Use KeepWordFilter(boolean, TokenStream, CharArraySet) instead
 
Method Summary
 boolean accept()
           
 
Methods inherited from class org.apache.lucene.analysis.FilteringTokenFilter
getEnablePositionIncrements, incrementToken, reset, setEnablePositionIncrements
 
Methods inherited from class org.apache.lucene.analysis.TokenFilter
close, end
 
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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

KeepWordFilter

@Deprecated
public KeepWordFilter(TokenStream in,
                                 Set<String> words,
                                 boolean ignoreCase)
Deprecated. Use KeepWordFilter(boolean, TokenStream, CharArraySet) instead


KeepWordFilter

public KeepWordFilter(boolean enablePositionIncrements,
                      TokenStream in,
                      CharArraySet words)
The words set passed to this constructor will be directly used by this filter and should not be modified,

Method Detail

accept

public boolean accept()
               throws IOException
Specified by:
accept in class FilteringTokenFilter
Throws:
IOException