Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
Lucene::BaseCharFilter Class Reference

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

#include <BaseCharFilter.h>

+ Inheritance diagram for Lucene::BaseCharFilter:

Public Member Functions

 BaseCharFilter (const CharStreamPtr &in)
 
virtual ~BaseCharFilter ()
 
virtual String getClassName ()
 
boost::shared_ptr< BaseCharFiltershared_from_this ()
 
- Public Member Functions inherited from Lucene::CharFilter
virtual ~CharFilter ()
 
boost::shared_ptr< CharFiltershared_from_this ()
 
- Public Member Functions inherited from Lucene::CharStream
virtual ~CharStream ()
 
boost::shared_ptr< CharStreamshared_from_this ()
 
- Public Member Functions inherited from Lucene::Reader
virtual ~Reader ()
 
boost::shared_ptr< Readershared_from_this ()
 
virtual int32_t read ()
 Read a single character.
 
virtual int64_t skip (int64_t n)
 Skip characters.
 
virtual int64_t length ()
 The number of bytes in the stream.
 
- Public Member Functions inherited from Lucene::LuceneObject
virtual ~LuceneObject ()
 
virtual void initialize ()
 Called directly after instantiation to create objects that depend on this object being fully constructed.
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
virtual String toString ()
 Returns a string representation of the object.
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock.
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal.
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout.
 
virtual void unlock ()
 Unlock this object.
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread.
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout.
 
virtual void notifyAll ()
 Notify all threads waiting for signal.
 

Static Public Member Functions

static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::CharFilter
static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::CharStream
static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::Reader
static String _getClassName ()
 

Protected Member Functions

virtual int32_t correct (int32_t currentOff)
 Retrieve the corrected offset.
 
int32_t getLastCumulativeDiff ()
 
void addOffCorrectMap (int32_t off, int32_t cumulativeDiff)
 
- Protected Member Functions inherited from Lucene::CharFilter
 CharFilter (const CharStreamPtr &in)
 
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.
 
- Protected Member Functions inherited from Lucene::Reader
 Reader ()
 
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Protected Attributes

IntArray offsets
 
IntArray diffs
 
int32_t size
 
- Protected Attributes inherited from Lucene::CharFilter
CharStreamPtr input
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

- Static Public Attributes inherited from Lucene::Reader
static const int32_t READER_EOF
 

Detailed Description

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

Constructor & Destructor Documentation

◆ BaseCharFilter()

Lucene::BaseCharFilter::BaseCharFilter ( const CharStreamPtr in)

◆ ~BaseCharFilter()

virtual Lucene::BaseCharFilter::~BaseCharFilter ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::BaseCharFilter::_getClassName ( )
inlinestatic

◆ addOffCorrectMap()

void Lucene::BaseCharFilter::addOffCorrectMap ( int32_t  off,
int32_t  cumulativeDiff 
)
protected

◆ correct()

virtual int32_t Lucene::BaseCharFilter::correct ( int32_t  currentOff)
protectedvirtual

Retrieve the corrected offset.

Reimplemented from Lucene::CharFilter.

◆ getClassName()

virtual String Lucene::BaseCharFilter::getClassName ( )
inlinevirtual

Reimplemented from Lucene::CharFilter.

Reimplemented in Lucene::MappingCharFilter.

◆ getLastCumulativeDiff()

int32_t Lucene::BaseCharFilter::getLastCumulativeDiff ( )
protected

◆ shared_from_this()

boost::shared_ptr< BaseCharFilter > Lucene::BaseCharFilter::shared_from_this ( )
inline

Field Documentation

◆ diffs

IntArray Lucene::BaseCharFilter::diffs
protected

◆ offsets

IntArray Lucene::BaseCharFilter::offsets
protected

◆ size

int32_t Lucene::BaseCharFilter::size
protected

The documentation for this class was generated from the following file:

clucene.sourceforge.net