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


lucene::search::Filter Class Reference

#include <Filter.h>

Inheritance diagram for lucene::search::Filter:

lucene::search::AbstractCachingFilter lucene::search::ChainedFilter lucene::search::DateFilter lucene::search::PrefixFilter lucene::search::QueryFilter lucene::search::RangeFilter lucene::search::WildcardFilter lucene::search::CachingWrapperFilter

Public Member Functions

virtual ~Filter ()
virtual Filterclone () const =0
virtual lucene::util::BitSetbits (lucene::index::IndexReader *reader)=0
 Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.
virtual bool shouldDeleteBitSet (const lucene::util::BitSet *bs) const
 Because of the problem of cached bitsets with the CachingWrapperFilter, CLucene has no way of knowing whether to delete the bitset returned from bits().
virtual TCHAR * toString ()=0

Constructor & Destructor Documentation

virtual lucene::search::Filter::~Filter (  )  [inline, virtual]


Member Function Documentation

virtual Filter* lucene::search::Filter::clone (  )  const [pure virtual]

virtual lucene:: util ::BitSet* lucene::search::Filter::bits ( lucene::index::IndexReader reader  )  [pure virtual]

Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.

MEMORY: read shouldDeleteBitSet

Implemented in lucene::search::AbstractCachingFilter, lucene::search::ChainedFilter, lucene::search::DateFilter, lucene::search::PrefixFilter, lucene::search::QueryFilter, lucene::search::RangeFilter, and lucene::search::WildcardFilter.

virtual bool lucene::search::Filter::shouldDeleteBitSet ( const lucene::util::BitSet bs  )  const [inline, virtual]

Because of the problem of cached bitsets with the CachingWrapperFilter, CLucene has no way of knowing whether to delete the bitset returned from bits().

To properly clean memory from bits(), pass the bitset to this function. The Filter should be deleted if this function returns true.

Reimplemented in lucene::search::AbstractCachingFilter.

virtual TCHAR* lucene::search::Filter::toString (  )  [pure virtual]


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

clucene.sourceforge.net