Package org.apache.lucene.analysis
Class CharFilter
- java.lang.Object
-
- java.io.Reader
-
- org.apache.lucene.analysis.CharFilter
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Readable
- Direct Known Subclasses:
BaseCharFilter
,PersianCharFilter
public abstract class CharFilter extends Reader
Subclasses of CharFilter can be chained to filter a Reader They can be used asReader
with additional offset correction.Tokenizer
s will automatically usecorrectOffset(int)
if a CharFilter subclass is used.This class is abstract: at a minimum you must implement
Reader.read(char[], int, int)
, transforming the input in some way frominput
, andcorrect(int)
to adjust the offsets to match the originals.You can optionally provide more efficient implementations of additional methods like
Reader.read()
,Reader.read(char[])
,Reader.read(java.nio.CharBuffer)
, but this is not required.For examples and integration with
Analyzer
, see theAnalysis package documentation
.
-
-
Constructor Summary
Constructors Constructor Description CharFilter(Reader input)
Create a new CharFilter wrapping the provided reader.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Closes the underlying input stream.int
correctOffset(int currentOff)
Chains the corrected offset through the input CharFilter(s).-
Methods inherited from class java.io.Reader
mark, markSupported, nullReader, read, read, read, read, ready, reset, skip, transferTo
-
-
-
-
Constructor Detail
-
CharFilter
public CharFilter(Reader input)
Create a new CharFilter wrapping the provided reader.- Parameters:
input
- a Reader, can also be a CharFilter for chaining.
-
-
Method Detail
-
close
public void close() throws IOException
Closes the underlying input stream.NOTE: The default implementation closes the input Reader, so be sure to call
super.close()
when overriding this method.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classReader
- Throws:
IOException
-
correctOffset
public final int correctOffset(int currentOff)
Chains the corrected offset through the input CharFilter(s).
-
-