xapian-core  1.4.20
Public Member Functions | Private Member Functions | List of all members
Xapian::Stopper Class Referenceabstract

Abstract base class for stop-word decision functor. More...

#include <queryparser.h>

+ Inheritance diagram for Xapian::Stopper:
+ Collaboration diagram for Xapian::Stopper:

Public Member Functions

 Stopper ()
 Default constructor. More...
 
virtual bool operator() (const std::string &term) const =0
 Is term a stop-word? More...
 
virtual ~Stopper ()
 Class has virtual methods, so provide a virtual destructor. More...
 
virtual std::string get_description () const
 Return a string describing this object. More...
 
Stopperrelease ()
 Start reference counting this object. More...
 
const Stopperrelease () const
 Start reference counting this object. More...
 
- Public Member Functions inherited from Xapian::Internal::opt_intrusive_base
 opt_intrusive_base (const opt_intrusive_base &)
 
opt_intrusive_baseoperator= (const opt_intrusive_base &)
 
 opt_intrusive_base ()
 Construct object which is initially not reference counted. More...
 
virtual ~opt_intrusive_base ()
 
void ref () const
 
void unref () const
 

Private Member Functions

void operator= (const Stopper &)
 Don't allow assignment. More...
 
 Stopper (const Stopper &)
 Don't allow copying. More...
 

Additional Inherited Members

- Public Attributes inherited from Xapian::Internal::opt_intrusive_base
unsigned _refs
 Reference count. More...
 
- Protected Member Functions inherited from Xapian::Internal::opt_intrusive_base
void release () const
 Start reference counting. More...
 

Detailed Description

Abstract base class for stop-word decision functor.

If you just want to use an existing stopword list, see Xapian::SimpleStopper.

Definition at line 50 of file queryparser.h.

Constructor & Destructor Documentation

◆ Stopper() [1/2]

Xapian::Stopper::Stopper ( const Stopper )
private

Don't allow copying.

◆ Stopper() [2/2]

Xapian::Stopper::Stopper ( )
inline

Default constructor.

Definition at line 60 of file queryparser.h.

◆ ~Stopper()

virtual Xapian::Stopper::~Stopper ( )
inlinevirtual

Class has virtual methods, so provide a virtual destructor.

Definition at line 69 of file queryparser.h.

Member Function Documentation

◆ get_description()

string Stopper::get_description ( ) const
virtual

Return a string describing this object.

Reimplemented in Xapian::SimpleStopper.

Definition at line 41 of file queryparser.cc.

◆ operator()()

virtual bool Xapian::Stopper::operator() ( const std::string &  term) const
pure virtual

Is term a stop-word?

Parameters
termThe term to test.

Implemented in TestStopper, and Xapian::SimpleStopper.

◆ operator=()

void Xapian::Stopper::operator= ( const Stopper )
private

Don't allow assignment.

◆ release() [1/2]

Stopper* Xapian::Stopper::release ( )
inline

Start reference counting this object.

You can hand ownership of a dynamically allocated Stopper object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

Definition at line 81 of file queryparser.h.

Referenced by DEFINE_TESTCASE().

◆ release() [2/2]

const Stopper* Xapian::Stopper::release ( ) const
inline

Start reference counting this object.

You can hand ownership of a dynamically allocated Stopper object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

Definition at line 93 of file queryparser.h.


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