org.apache.lucene.analysis.charfilter
Class BaseCharFilter

java.lang.Object
  extended by java.io.Reader
      extended by org.apache.lucene.analysis.CharStream
          extended by org.apache.lucene.analysis.charfilter.CharFilter
              extended by org.apache.lucene.analysis.charfilter.BaseCharFilter
All Implemented Interfaces:
Closeable, Readable
Direct Known Subclasses:
HTMLStripCharFilter, MappingCharFilter, PatternReplaceCharFilter

public abstract class BaseCharFilter
extends CharFilter

Base utility class for implementing a CharFilter. You subclass this, and then record mappings by calling addOffCorrectMap(int, int), and then invoke the correct method to correct an offset.


Field Summary
 
Fields inherited from class org.apache.lucene.analysis.charfilter.CharFilter
input
 
Fields inherited from class java.io.Reader
lock
 
Constructor Summary
BaseCharFilter(CharStream in)
           
 
Method Summary
protected  void addOffCorrectMap(int off, int cumulativeDiff)
           Adds an offset correction mapping at the given output stream offset.
protected  int correct(int currentOff)
          Retrieve the corrected offset.
protected  int getLastCumulativeDiff()
           
 
Methods inherited from class org.apache.lucene.analysis.charfilter.CharFilter
close, correctOffset, mark, markSupported, read, reset
 
Methods inherited from class java.io.Reader
read, read, read, ready, skip
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseCharFilter

public BaseCharFilter(CharStream in)
Method Detail

correct

protected int correct(int currentOff)
Retrieve the corrected offset.

Overrides:
correct in class CharFilter
Parameters:
currentOff - current offset
Returns:
corrected offset

getLastCumulativeDiff

protected int getLastCumulativeDiff()

addOffCorrectMap

protected void addOffCorrectMap(int off,
                                int cumulativeDiff)

Adds an offset correction mapping at the given output stream offset.

Assumption: the offset given with each successive call to this method will not be smaller than the offset given at the previous invocation.

Parameters:
off - The output stream offset at which to apply the correction
cumulativeDiff - The input offset is given by adding this to the output offset


Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.