Subclasses of CharFilter can be chained to filter CharStream. They can be used as Reader
with additional offset correction. Tokenizer
s will automatically use correctOffset
if a CharFilter/CharStream subclass is used.
More...
#include <CharFilter.h>
|
| CharFilter (const CharStreamPtr &in) |
|
virtual int32_t | correct (int32_t currentOff) |
| Subclass may want to override to correct the current offset.
|
|
virtual int32_t | correctOffset (int32_t currentOff) |
| Chains the corrected offset through the input CharFilter.
|
|
virtual void | close () |
| Close the stream.
|
|
virtual int32_t | read (wchar_t *buffer, int32_t offset, int32_t length) |
| Read characters into a portion of an array.
|
|
virtual bool | markSupported () |
| Tell whether this stream supports the mark() operation.
|
|
virtual void | mark (int32_t readAheadLimit) |
| Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.
|
|
virtual void | reset () |
| Reset the stream. If the stream has been marked, then attempt to reposition it at the mark. If the stream has not been marked, then attempt to reset it in some way appropriate to the particular stream, for example by repositioning it to its starting point.
|
|
| Reader () |
|
| LuceneObject () |
|
Subclasses of CharFilter can be chained to filter CharStream. They can be used as Reader
with additional offset correction. Tokenizer
s will automatically use correctOffset
if a CharFilter/CharStream subclass is used.
◆ CharFilter()
◆ ~CharFilter()
virtual Lucene::CharFilter::~CharFilter |
( |
| ) |
|
|
virtual |
◆ _getClassName()
static String Lucene::CharFilter::_getClassName |
( |
| ) |
|
|
inlinestatic |
◆ close()
virtual void Lucene::CharFilter::close |
( |
| ) |
|
|
protectedvirtual |
◆ correct()
virtual int32_t Lucene::CharFilter::correct |
( |
int32_t |
currentOff | ) |
|
|
protectedvirtual |
Subclass may want to override to correct the current offset.
- Parameters
-
- Returns
- corrected offset
Reimplemented in Lucene::BaseCharFilter.
◆ correctOffset()
virtual int32_t Lucene::CharFilter::correctOffset |
( |
int32_t |
currentOff | ) |
|
|
protectedvirtual |
◆ getClassName()
virtual String Lucene::CharFilter::getClassName |
( |
| ) |
|
|
inlinevirtual |
◆ mark()
virtual void Lucene::CharFilter::mark |
( |
int32_t |
readAheadLimit | ) |
|
|
protectedvirtual |
Mark the present position in the stream. Subsequent calls to reset() will attempt to reposition the stream to this point.
Reimplemented from Lucene::Reader.
◆ markSupported()
virtual bool Lucene::CharFilter::markSupported |
( |
| ) |
|
|
protectedvirtual |
◆ read()
virtual int32_t Lucene::CharFilter::read |
( |
wchar_t * |
buffer, |
|
|
int32_t |
offset, |
|
|
int32_t |
length |
|
) |
| |
|
protectedvirtual |
◆ reset()
virtual void Lucene::CharFilter::reset |
( |
| ) |
|
|
protectedvirtual |
Reset the stream. If the stream has been marked, then attempt to reposition it at the mark. If the stream has not been marked, then attempt to reset it in some way appropriate to the particular stream, for example by repositioning it to its starting point.
Reimplemented from Lucene::Reader.
◆ shared_from_this()
boost::shared_ptr< CharFilter > Lucene::CharFilter::shared_from_this |
( |
| ) |
|
|
inline |
◆ input
The documentation for this class was generated from the following file: