1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: Xapian::KeyMaker 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.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1KeyMaker.html">KeyMaker</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1KeyMaker-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::KeyMaker Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Virtual base class for key making functors.
<a href="classXapian_1_1KeyMaker.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Xapian::KeyMaker:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classXapian_1_1KeyMaker__inherit__graph.png" border="0" usemap="#Xapian_1_1KeyMaker_inherit__map" alt="Inheritance graph"/></div>
<map name="Xapian_1_1KeyMaker_inherit__map" id="Xapian_1_1KeyMaker_inherit__map">
<area shape="rect" id="node3" href="classXapian_1_1MultiValueKeyMaker.html" title="KeyMaker subclass which combines several values. " alt="" coords="5,83,195,112"/><area shape="rect" id="node5" href="classXapian_1_1Sorter.html" title="Virtual base class for sorter functor. " alt="" coords="219,83,323,112"/><area shape="rect" id="node7" href="classXapian_1_1MultiValueSorter.html" title="Sorter subclass which sorts by a several values. " alt="" coords="188,160,353,189"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acd0a775f8546a830833357e5d792bedc"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1KeyMaker.html#acd0a775f8546a830833357e5d792bedc">operator()</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &doc) const =0</td></tr>
<tr class="memdesc:acd0a775f8546a830833357e5d792bedc"><td class="mdescLeft"> </td><td class="mdescRight">Build a key string for a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database. ">Document</a>. <a href="#acd0a775f8546a830833357e5d792bedc">More...</a><br/></td></tr>
<tr class="separator:acd0a775f8546a830833357e5d792bedc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3536ee93f8588a7af834212e9c09c5f8"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1KeyMaker.html#a3536ee93f8588a7af834212e9c09c5f8">~KeyMaker</a> ()</td></tr>
<tr class="memdesc:a3536ee93f8588a7af834212e9c09c5f8"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor, because we have virtual methods. <a href="#a3536ee93f8588a7af834212e9c09c5f8">More...</a><br/></td></tr>
<tr class="separator:a3536ee93f8588a7af834212e9c09c5f8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Virtual base class for key making functors. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3536ee93f8588a7af834212e9c09c5f8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Xapian::KeyMaker::~KeyMaker </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor, because we have virtual methods. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acd0a775f8546a830833357e5d792bedc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::KeyMaker::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> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a key string for a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database. ">Document</a>. </p>
<p>These keys can be used for sorting or collapsing matching documents.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">doc</td><td><a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database. ">Document</a> object to build a key for. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classXapian_1_1MultiValueSorter.html#a91f7cc327f2b2101eb947e1c4ef667ff">Xapian::MultiValueSorter</a>, and <a class="el" href="classXapian_1_1MultiValueKeyMaker.html#a8f827517ed1ea394f99d4db362f23b31">Xapian::MultiValueKeyMaker</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="keymaker_8h.html">keymaker.h</a></li>
</ul>
</div><!-- contents -->
<hr>
<address><small>
Documentation for Xapian (version 1.2.16).<br>
Generated on Wed Dec 4 2013 by
<a href="http://www.doxygen.org/">Doxygen 1.8.5</a>.
</small></address>
</body>
</html>
|
