public abstract class

BaseCharFilter

extends CharFilter
java.lang.Object
   ↳ java.io.Reader
     ↳ org.apache.lucene.analysis.CharStream
       ↳ org.apache.lucene.analysis.CharFilter
         ↳ org.apache.lucene.analysis.BaseCharFilter
Known Direct Subclasses

Class Overview

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.

Summary

[Expand]
Inherited Fields
From class org.apache.lucene.analysis.CharFilter
From class java.io.Reader
Public Constructors
BaseCharFilter(CharStream in)
Protected Methods
void addOffCorrectMap(int off, int cumulativeDiff)
int correct(int currentOff)
Retrieve the corrected offset.
int getLastCumulativeDiff()
[Expand]
Inherited Methods
From class org.apache.lucene.analysis.CharFilter
From class org.apache.lucene.analysis.CharStream
From class java.io.Reader
From class java.lang.Object
From interface java.io.Closeable
From interface java.lang.Readable

Public Constructors

public BaseCharFilter (CharStream in)

Protected Methods

protected void addOffCorrectMap (int off, int cumulativeDiff)

protected int correct (int currentOff)

Retrieve the corrected offset.

Parameters
currentOff current offset
Returns
  • corrected offset

protected int getLastCumulativeDiff ()