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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions
Lucene::PrefixFilter Class Reference

A Filter that restricts search results to values that have a matching prefix in a given field. More...

#include <PrefixFilter.h>

+ Inheritance diagram for Lucene::PrefixFilter:

Public Member Functions

 PrefixFilter (const TermPtr &prefix)
 
virtual ~PrefixFilter ()
 
virtual String getClassName ()
 
boost::shared_ptr< PrefixFiltershared_from_this ()
 
TermPtr getPrefix ()
 
virtual String toString ()
 Returns a string representation of the object.
 
- Public Member Functions inherited from Lucene::MultiTermQueryWrapperFilter
virtual ~MultiTermQueryWrapperFilter ()
 
boost::shared_ptr< MultiTermQueryWrapperFiltershared_from_this ()
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
int32_t getTotalNumberOfTerms ()
 Return the number of unique terms visited during execution of the filter. If there are many of them, you may consider using another filter type or optimize your total term count in index.
 
void clearTotalNumberOfTerms ()
 Resets the counting of unique terms. Do this before executing the filter.
 
virtual DocIdSetPtr getDocIdSet (const IndexReaderPtr &reader)
 Returns a DocIdSet with documents that should be permitted in search results.
 
- 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.
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object.
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
- 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::MultiTermQueryWrapperFilter
static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::Filter
static String _getClassName ()
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 
- Protected Attributes inherited from Lucene::MultiTermQueryWrapperFilter
MultiTermQueryPtr query
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

A Filter that restricts search results to values that have a matching prefix in a given field.

Constructor & Destructor Documentation

◆ PrefixFilter()

Lucene::PrefixFilter::PrefixFilter ( const TermPtr prefix)

◆ ~PrefixFilter()

virtual Lucene::PrefixFilter::~PrefixFilter ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ getClassName()

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

◆ getPrefix()

TermPtr Lucene::PrefixFilter::getPrefix ( )

◆ shared_from_this()

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

◆ toString()

virtual String Lucene::PrefixFilter::toString ( )
virtual

Returns a string representation of the object.

Reimplemented from Lucene::MultiTermQueryWrapperFilter.


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

clucene.sourceforge.net