Save This Page
Home » lucene-3.0.1-src » org.apache » lucene » analysis » [javadoc | source]
org.apache.lucene.analysis
abstract public class: CharFilter [javadoc | source]
java.lang.Object
   java.io.Reader
      org.apache.lucene.analysis.CharStream
         org.apache.lucene.analysis.CharFilter

All Implemented Interfaces:
    Closeable, Readable

Direct Known Subclasses:
    MappingCharFilter, BaseCharFilter

Subclasses of CharFilter can be chained to filter CharStream. They can be used as java.io.Reader with additional offset correction. Tokenizer s will automatically use #correctOffset if a CharFilter/CharStream subclass is used.
Field Summary
protected  CharStream input     
Fields inherited from java.io.Reader:
lock
Constructor:
 protected CharFilter(CharStream in) 
Method from org.apache.lucene.analysis.CharFilter Summary:
close,   correct,   correctOffset,   mark,   markSupported,   read,   reset
Methods from org.apache.lucene.analysis.CharStream:
correctOffset
Methods from java.io.Reader:
close,   mark,   markSupported,   read,   read,   read,   read,   ready,   reset,   skip
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.analysis.CharFilter Detail:
 public  void close() throws IOException 
 protected int correct(int currentOff) 
    Subclass may want to override to correct the current offset.
 public final int correctOffset(int currentOff) 
    Chains the corrected offset through the input CharFilter.
 public  void mark(int readAheadLimit) throws IOException 
 public boolean markSupported() 
 public int read(char[] cbuf,
    int off,
    int len) throws IOException 
 public  void reset() throws IOException