Public Member Functions | List of all members
Xapian::KeyMaker Class Referenceabstract

Virtual base class for key making functors. More...

+ Inheritance diagram for Xapian::KeyMaker:

Public Member Functions

 KeyMaker ()
 Default constructor.
 
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...
 
KeyMakerrelease ()
 Start reference counting this object. More...
 
const KeyMakerrelease () const
 Start reference counting this object. More...
 

Detailed Description

Virtual base class for key making functors.

Constructor & Destructor Documentation

◆ ~KeyMaker()

virtual Xapian::KeyMaker::~KeyMaker ( )
virtual

Virtual destructor, because we have virtual methods.

Member Function Documentation

◆ operator()()

virtual std::string Xapian::KeyMaker::operator() ( const Xapian::Document doc) const
pure virtual

Build a key string for a Document.

These keys can be used for sorting or collapsing matching documents.

Parameters
docDocument object to build a key for.

Implemented in Xapian::LatLongDistanceKeyMaker, and Xapian::MultiValueKeyMaker.

◆ release() [1/2]

KeyMaker* Xapian::KeyMaker::release ( )
inline

Start reference counting this object.

You can hand 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.

◆ release() [2/2]

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

Start reference counting this object.

You can hand 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.


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

Documentation for Xapian (version 1.4.9).
Generated on Sat Nov 3 2018 by Doxygen 1.8.13.