Virtual base class for key making functors. More...
#include <keymaker.h>
Inheritance diagram for Xapian::KeyMaker:
Collaboration diagram for Xapian::KeyMaker:
Public Member Functions | |
| KeyMaker () | |
| Default constructor. More... | |
| virtual std::string | operator() (const Xapian::Document &doc) const =0 |
| Build a key string for a Document. More... | |
| virtual | ~KeyMaker () |
| Virtual destructor, because we have virtual methods. More... | |
| KeyMaker * | release () |
| Start reference counting this object. More... | |
| const KeyMaker * | release () 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_base & | operator= (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 KeyMaker &) |
| Don't allow assignment. More... | |
| KeyMaker (const KeyMaker &) | |
| 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
Virtual base class for key making functors.
Definition at line 41 of file keymaker.h.
Constructor & Destructor Documentation
◆ KeyMaker() [1/2]
|
private |
Don't allow copying.
◆ KeyMaker() [2/2]
|
inline |
Default constructor.
Definition at line 51 of file keymaker.h.
◆ ~KeyMaker()
|
virtual |
Virtual destructor, because we have virtual methods.
Definition at line 35 of file keymaker.cc.
Member Function Documentation
◆ operator()()
|
pure virtual |
Build a key string for a Document.
These keys can be used for sorting or collapsing matching documents.
- Parameters
-
doc Document object to build a key for.
Implemented in Xapian::LatLongDistanceKeyMaker, TestKeyMaker, NeverUseMeKeyMaker, and Xapian::MultiValueKeyMaker.
◆ operator=()
|
private |
Don't allow assignment.
◆ release() [1/2]
|
inline |
Start reference counting this object.
You can transfer ownership of a dynamically allocated KeyMaker 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 71 of file keymaker.h.
Referenced by DEFINE_TESTCASE().
◆ release() [2/2]
|
inline |
Start reference counting this object.
You can transfer ownership of a dynamically allocated KeyMaker 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 83 of file keymaker.h.
The documentation for this class was generated from the following files:
- include/xapian/keymaker.h
- api/keymaker.cc