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 ()
 
const KeyMakerrelease () const
 

Detailed Description

Virtual base class for key making functors.

Constructor & Destructor Documentation

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

Virtual destructor, because we have virtual methods.

Member Function Documentation

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.


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

Documentation for Xapian (version 1.4.0).
Generated on Wed Oct 12 2016 by Doxygen 1.8.11.