File: classXapian_1_1KeyMaker.html

package info (click to toggle)
xapian-core 1.4.22-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 22,816 kB
  • sloc: cpp: 92,138; ansic: 9,983; sh: 4,929; perl: 850; makefile: 503; javascript: 331; tcl: 319; python: 40
file content (197 lines) | stat: -rw-r--r-- 12,784 bytes parent folder | download 
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::KeyMaker Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">xapian-core
   &#160;<span id="projectnumber">1.4.22</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></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> &#124;
<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>

<p><code>#include &lt;keymaker.h&gt;</code></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="#aXapian_1_1KeyMaker_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1KeyMaker_inherit__map" id="aXapian_1_1KeyMaker_inherit__map">
<area shape="rect" title="Virtual base class for key making functors." alt="" coords="155,95,294,121"/>
<area shape="rect" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude." alt="" coords="5,169,212,211"/>
<area shape="rect" href="classXapian_1_1MultiValueKeyMaker.html" title="KeyMaker subclass which combines several values." alt="" coords="236,177,445,203"/>
<area shape="rect" title=" " alt="" coords="147,5,302,47"/>
</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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa3763f7445b5b20dffa6448ffc9ae0ed"><td class="memItemLeft" align="right" valign="top"><a id="aa3763f7445b5b20dffa6448ffc9ae0ed" name="aa3763f7445b5b20dffa6448ffc9ae0ed"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>KeyMaker</b> ()</td></tr>
<tr class="memdesc:aa3763f7445b5b20dffa6448ffc9ae0ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:aa3763f7445b5b20dffa6448ffc9ae0ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd0a775f8546a830833357e5d792bedc"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</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> &amp;doc) const =0</td></tr>
<tr class="memdesc:acd0a775f8546a830833357e5d792bedc"><td class="mdescLeft">&#160;</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="classXapian_1_1KeyMaker.html#acd0a775f8546a830833357e5d792bedc">More...</a><br /></td></tr>
<tr class="separator:acd0a775f8546a830833357e5d792bedc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3536ee93f8588a7af834212e9c09c5f8"><td class="memItemLeft" align="right" valign="top"><a id="a3536ee93f8588a7af834212e9c09c5f8" name="a3536ee93f8588a7af834212e9c09c5f8"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~KeyMaker</b> ()</td></tr>
<tr class="memdesc:a3536ee93f8588a7af834212e9c09c5f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor, because we have virtual methods. <br /></td></tr>
<tr class="separator:a3536ee93f8588a7af834212e9c09c5f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab62225b04de86a94b262cb99d91b25fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1KeyMaker.html">KeyMaker</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1KeyMaker.html#ab62225b04de86a94b262cb99d91b25fa">release</a> ()</td></tr>
<tr class="memdesc:ab62225b04de86a94b262cb99d91b25fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start reference counting this object.  <a href="classXapian_1_1KeyMaker.html#ab62225b04de86a94b262cb99d91b25fa">More...</a><br /></td></tr>
<tr class="separator:ab62225b04de86a94b262cb99d91b25fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c930f836b425c9694c77bd6b314f66b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1KeyMaker.html">KeyMaker</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1KeyMaker.html#a5c930f836b425c9694c77bd6b314f66b">release</a> () const</td></tr>
<tr class="memdesc:a5c930f836b425c9694c77bd6b314f66b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start reference counting this object.  <a href="classXapian_1_1KeyMaker.html#a5c930f836b425c9694c77bd6b314f66b">More...</a><br /></td></tr>
<tr class="separator:a5c930f836b425c9694c77bd6b314f66b"><td class="memSeparator" colspan="2">&#160;</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">Member Function Documentation</h2>
<a id="acd0a775f8546a830833357e5d792bedc" name="acd0a775f8546a830833357e5d792bedc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd0a775f8546a830833357e5d792bedc">&#9670;&nbsp;</a></span>operator()()</h2>

<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> &amp;&#160;</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_1LatLongDistanceKeyMaker.html#a931a11c99b88b0813e7a6c0110c407c7">Xapian::LatLongDistanceKeyMaker</a>, and <a class="el" href="classXapian_1_1MultiValueKeyMaker.html#a84575318ca4709ae352dd85dd143cb89">Xapian::MultiValueKeyMaker</a>.</p>

</div>
</div>
<a id="ab62225b04de86a94b262cb99d91b25fa" name="ab62225b04de86a94b262cb99d91b25fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab62225b04de86a94b262cb99d91b25fa">&#9670;&nbsp;</a></span>release() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classXapian_1_1KeyMaker.html">KeyMaker</a> * Xapian::KeyMaker::release </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Start reference counting this object. </p>
<p >You can hand ownership of a dynamically allocated <a class="el" href="classXapian_1_1KeyMaker.html" title="Virtual base class for key making functors.">KeyMaker</a> object to <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> by calling <a class="el" href="classXapian_1_1KeyMaker.html#ab62225b04de86a94b262cb99d91b25fa" title="Start reference counting this object.">release()</a> and then passing the object to a <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> method. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will arrange to delete the object once it is no longer required. </p>

</div>
</div>
<a id="a5c930f836b425c9694c77bd6b314f66b" name="a5c930f836b425c9694c77bd6b314f66b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c930f836b425c9694c77bd6b314f66b">&#9670;&nbsp;</a></span>release() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classXapian_1_1KeyMaker.html">KeyMaker</a> * Xapian::KeyMaker::release </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Start reference counting this object. </p>
<p >You can hand ownership of a dynamically allocated <a class="el" href="classXapian_1_1KeyMaker.html" title="Virtual base class for key making functors.">KeyMaker</a> object to <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> by calling <a class="el" href="classXapian_1_1KeyMaker.html#ab62225b04de86a94b262cb99d91b25fa" title="Start reference counting this object.">release()</a> and then passing the object to a <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> method. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will arrange to delete the object once it is no longer required. </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 -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.4</a>
</small></address>
</body>
</html>