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


 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
Lucene::CachingSpanFilter Class Reference

Wraps another SpanFilter's result and caches it. The purpose is to allow filters to simply filter, and then wrap with this class to add caching. More...

#include <CachingSpanFilter.h>

+ Inheritance diagram for Lucene::CachingSpanFilter:

Public Member Functions

 CachingSpanFilter (SpanFilterPtr filter, CachingWrapperFilter::DeletesMode deletesMode=CachingWrapperFilter::DELETES_RECACHE)
 New deletions always result in a cache miss, by default (CachingWrapperFilter#RECACHE. More...
 
virtual ~CachingSpanFilter ()
 
virtual String getClassName ()
 
boost::shared_ptr
< CachingSpanFilter
shared_from_this ()
 
virtual DocIdSetPtr getDocIdSet (IndexReaderPtr reader)
 Creates a DocIdSet enumerating the documents that should be permitted in search results. More...
 
virtual SpanFilterResultPtr bitSpans (IndexReaderPtr reader)
 Returns a SpanFilterResult with true for documents which should be permitted in search results, and false for those that should not and Spans for where the true docs match. More...
 
virtual String toString ()
 Returns a string representation of the object. More...
 
virtual bool equals (LuceneObjectPtr other)
 Return whether two objects are equal. More...
 
virtual int32_t hashCode ()
 Return hash code for this object. More...
 
- Public Member Functions inherited from Lucene::SpanFilter
virtual ~SpanFilter ()
 
boost::shared_ptr< SpanFiltershared_from_this ()
 
- Public Member Functions inherited from Lucene::Filter
virtual ~Filter ()
 
boost::shared_ptr< Filtershared_from_this ()
 
- 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. More...
 
virtual LuceneObjectPtr clone (LuceneObjectPtr other=LuceneObjectPtr())
 Return clone of this object. More...
 
virtual int32_t compareTo (LuceneObjectPtr other)
 Compare two objects. More...
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock. More...
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal. More...
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout. More...
 
virtual void unlock ()
 Unlock this object. More...
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread. More...
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout. More...
 
virtual void notifyAll ()
 Notify all threads waiting for signal. More...
 

Static Public Member Functions

static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::SpanFilter
static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::Filter
static String _getClassName ()
 

Data Fields

int32_t hitCount
 
int32_t missCount
 

Protected Member Functions

SpanFilterResultPtr getCachedResult (IndexReaderPtr reader)
 

Protected Attributes

SpanFilterPtr filter
 
FilterCachePtr cache
 

Detailed Description

Wraps another SpanFilter's result and caches it. The purpose is to allow filters to simply filter, and then wrap with this class to add caching.

Constructor & Destructor Documentation

Lucene::CachingSpanFilter::CachingSpanFilter ( SpanFilterPtr  filter,
CachingWrapperFilter::DeletesMode  deletesMode = CachingWrapperFilter::DELETES_RECACHE 
)

New deletions always result in a cache miss, by default (CachingWrapperFilter#RECACHE.

virtual Lucene::CachingSpanFilter::~CachingSpanFilter ( )
virtual

Member Function Documentation

static String Lucene::CachingSpanFilter::_getClassName ( )
inlinestatic
virtual SpanFilterResultPtr Lucene::CachingSpanFilter::bitSpans ( IndexReaderPtr  reader)
virtual

Returns a SpanFilterResult with true for documents which should be permitted in search results, and false for those that should not and Spans for where the true docs match.

Parameters
readerThe IndexReader to load position and DocIdSet information from
Returns
A SpanFilterResult

Implements Lucene::SpanFilter.

virtual bool Lucene::CachingSpanFilter::equals ( LuceneObjectPtr  other)
virtual

Return whether two objects are equal.

Reimplemented from Lucene::LuceneObject.

SpanFilterResultPtr Lucene::CachingSpanFilter::getCachedResult ( IndexReaderPtr  reader)
protected
virtual String Lucene::CachingSpanFilter::getClassName ( )
inlinevirtual

Reimplemented from Lucene::SpanFilter.

virtual DocIdSetPtr Lucene::CachingSpanFilter::getDocIdSet ( IndexReaderPtr  reader)
virtual

Creates a DocIdSet enumerating the documents that should be permitted in search results.

Note: null can be returned if no documents are accepted by this Filter.

Note: This method will be called once per segment in the index during searching. The returned DocIdSet must refer to document IDs for that segment, not for the top-level reader.

Parameters
readera IndexReader instance opened on the index currently searched on. Note, it is likely that the provided reader does not represent the whole underlying index ie. if the index has more than one segment the given reader only represents a single segment.
Returns
a DocIdSet that provides the documents which should be permitted or prohibited in search results. NOTE: null can be returned if no documents will be accepted by this Filter.
See Also
DocIdBitSet

Implements Lucene::Filter.

virtual int32_t Lucene::CachingSpanFilter::hashCode ( )
virtual

Return hash code for this object.

Reimplemented from Lucene::LuceneObject.

boost::shared_ptr< CachingSpanFilter > Lucene::CachingSpanFilter::shared_from_this ( )
inline
virtual String Lucene::CachingSpanFilter::toString ( )
virtual

Returns a string representation of the object.

Reimplemented from Lucene::LuceneObject.

Field Documentation

FilterCachePtr Lucene::CachingSpanFilter::cache
protected
SpanFilterPtr Lucene::CachingSpanFilter::filter
protected
int32_t Lucene::CachingSpanFilter::hitCount
int32_t Lucene::CachingSpanFilter::missCount

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

clucene.sourceforge.net