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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: 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.5.9 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1KeyMaker.html">KeyMaker</a>
</div>
</div>
<div class="contents">
<h1>Xapian::KeyMaker Class Reference</h1><!-- doxytag: class="Xapian::KeyMaker" -->Virtual base class for key making functors.
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for Xapian::KeyMaker:</div>
<div class="dynsection">
<p><center><img src="classXapian_1_1KeyMaker__inherit__graph.png" border="0" usemap="#Xapian_1_1KeyMaker__inherit__map" alt="Inheritance graph"></center>
<map name="Xapian_1_1KeyMaker__inherit__map">
<area shape="rect" href="classXapian_1_1MultiValueKeyMaker.html" title="KeyMaker subclass which combines several values." alt="" coords="5,84,203,111"><area shape="rect" href="classXapian_1_1Sorter.html" title="Virtual base class for sorter functor." alt="" coords="227,84,339,111"><area shape="rect" href="classXapian_1_1MultiValueSorter.html" title="Sorter subclass which sorts by a several values." alt="" coords="195,161,371,188"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classXapian_1_1KeyMaker-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_1KeyMaker.html#cd0a775f8546a830833357e5d792bedc">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">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="#cd0a775f8546a830833357e5d792bedc"></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_1KeyMaker.html#3536ee93f8588a7af834212e9c09c5f8">~KeyMaker</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor, because we have virtual methods. <a href="#3536ee93f8588a7af834212e9c09c5f8"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Virtual base class for key making functors.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3536ee93f8588a7af834212e9c09c5f8"></a><!-- doxytag: member="Xapian::KeyMaker::~KeyMaker" ref="3536ee93f8588a7af834212e9c09c5f8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Xapian::KeyMaker::~KeyMaker </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><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="cd0a775f8546a830833357e5d792bedc"></a><!-- doxytag: member="Xapian::KeyMaker::operator()" ref="cd0a775f8546a830833357e5d792bedc" args="(const Xapian::Document &doc) const =0" -->
<div class="memitem">
<div class="memproto">
<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<code> [pure virtual]</code></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>
These keys can be used for sorting or collapsing matching documents.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>doc</em> </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>
</dl>
<p>Implemented in <a class="el" href="classXapian_1_1MultiValueKeyMaker.html#8f827517ed1ea394f99d4db362f23b31">Xapian::MultiValueKeyMaker</a>, and <a class="el" href="classXapian_1_1MultiValueSorter.html#91f7cc327f2b2101eb947e1c4ef667ff">Xapian::MultiValueSorter</a>.</p>
</div>
</div><p>
<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></ul>
</div>
<hr>
<address><small>
Documentation for Xapian (version 1.2.12).<br>
Generated on 27 Jun 2012 by
<a href="http://www.doxygen.org/">Doxygen 1.5.9</a>.
</small></address>
</body>
</html>
|
