org.apache.lucene.analysis.charfilter
Class BaseCharFilter
java.lang.Object
java.io.Reader
org.apache.lucene.analysis.CharFilter
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.
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
BaseCharFilter
public BaseCharFilter(Reader in)
correct
protected int correct(int currentOff)
- Retrieve the corrected offset.
- Specified by:
correct
in class CharFilter
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 correctioncumulativeDiff
- The input offset is given by adding this
to the output offset
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.