Save This Page
Home » lucene-3.0.1-src » org.apache » lucene » analysis » [javadoc | source]
org.apache.lucene.analysis
abstract public class: TokenFilter [javadoc | source]
java.lang.Object
   org.apache.lucene.util.AttributeSource
      org.apache.lucene.analysis.TokenStream
         org.apache.lucene.analysis.TokenFilter

All Implemented Interfaces:
    Closeable

A TokenFilter is a TokenStream whose input is another TokenStream.

This is an abstract class; subclasses must override #incrementToken() .

Field Summary
protected final  TokenStream input    The source of tokens for this filter. 
Constructor:
 protected TokenFilter(TokenStream input) 
    Construct a token stream filtering the given input.
Method from org.apache.lucene.analysis.TokenFilter Summary:
close,   end,   reset
Methods from org.apache.lucene.analysis.TokenStream:
close,   end,   incrementToken,   reset
Methods from org.apache.lucene.util.AttributeSource:
addAttribute,   addAttributeImpl,   captureState,   clearAttributes,   cloneAttributes,   equals,   getAttribute,   getAttributeClassesIterator,   getAttributeFactory,   getAttributeImplsIterator,   hasAttribute,   hasAttributes,   hashCode,   restoreState,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.analysis.TokenFilter Detail:
 public  void close() throws IOException 
    Close the input TokenStream.
 public  void end() throws IOException 
    Performs end-of-stream operations, if any, and calls then end() on the input TokenStream.

    NOTE: Be sure to call super.end() first when overriding this method.

 public  void reset() throws IOException 
    Reset the filter as well as the input TokenStream.