<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::Sorter Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1Sorter.html">Sorter</a></div>
<h1>Xapian::Sorter Class Reference</h1><!-- doxytag: class="Xapian::Sorter" -->Virtual base class for sorter functor.
<a href="#_details">More...</a>
<p>
Inheritance diagram for Xapian::Sorter:<p><center><img src="classXapian_1_1Sorter__inherit__graph.png" border="0" usemap="#Xapian_1_1Sorter__inherit__map" alt="Inheritance graph"></center>
<map name="Xapian_1_1Sorter__inherit__map">
<area shape="rect" href="classXapian_1_1MultiValueSorter.html" title="Sorter subclass which sorts by a several values." alt="" coords="5,84,181,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXapian_1_1Sorter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Sorter.html#c4f6a19bac77dda0a6d52dbbe36a2200">operator()</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &doc) const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method takes a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database.">Document</a> object and builds a sort key from it. <a href="#c4f6a19bac77dda0a6d52dbbe36a2200"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Sorter.html#d32f0f4f218617b00ad9595d5f59d7f5">~Sorter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor, because we have virtual methods. <a href="#d32f0f4f218617b00ad9595d5f59d7f5"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Virtual base class for sorter functor.
<p>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="d32f0f4f218617b00ad9595d5f59d7f5"></a><!-- doxytag: member="Xapian::Sorter::~Sorter" ref="d32f0f4f218617b00ad9595d5f59d7f5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Xapian::Sorter::~Sorter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Virtual destructor, because we have virtual methods.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c4f6a19bac77dda0a6d52dbbe36a2200"></a><!-- doxytag: member="Xapian::Sorter::operator()" ref="c4f6a19bac77dda0a6d52dbbe36a2200" args="(const Xapian::Document &doc) const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::Sorter::operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> & </td>
<td class="paramname"> <em>doc</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method takes a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database.">Document</a> object and builds a sort key from it.
<p>
Documents are then ordered by a string compare on the sort keys.
<p>
Implemented in <a class="el" href="classXapian_1_1MultiValueSorter.html#bc7d5707dcfcc65c4b46dfc5aa9c7fcf">Xapian::MultiValueSorter</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="sorter_8h.html">sorter.h</a></ul>
<hr>
<address><small>
Documentation for Xapian (version 1.0.21).<br>
Generated on 18 Jun 2010 by
<a href="http://www.doxygen.org/">Doxygen 1.5.2</a>.
</small></address>
</body>
</html>
