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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
|
<!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::Registry 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
 <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&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_1Registry.html">Registry</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1Registry-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Xapian::Registry Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classXapian_1_1Registry.html" title="Registry for user subclasses.">Registry</a> for user subclasses.
<a href="classXapian_1_1Registry.html#details">More...</a></p>
<p><code>#include <registry.h></code></p>
<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:a35540e2b99265677d41b8170c87ad3e6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html#a35540e2b99265677d41b8170c87ad3e6">Registry</a> (const <a class="el" href="classXapian_1_1Registry.html">Registry</a> &other)</td></tr>
<tr class="memdesc:a35540e2b99265677d41b8170c87ad3e6"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="classXapian_1_1Registry.html#a35540e2b99265677d41b8170c87ad3e6">More...</a><br /></td></tr>
<tr class="separator:a35540e2b99265677d41b8170c87ad3e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a954e19523b2584fcc8b5f0df2da30424"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Registry.html">Registry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html#a954e19523b2584fcc8b5f0df2da30424">operator=</a> (const <a class="el" href="classXapian_1_1Registry.html">Registry</a> &other)</td></tr>
<tr class="memdesc:a954e19523b2584fcc8b5f0df2da30424"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="classXapian_1_1Registry.html#a954e19523b2584fcc8b5f0df2da30424">More...</a><br /></td></tr>
<tr class="separator:a954e19523b2584fcc8b5f0df2da30424"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2074a878db895c3fb3eaa3c18f11244a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html#a2074a878db895c3fb3eaa3c18f11244a">Registry</a> ()</td></tr>
<tr class="memdesc:a2074a878db895c3fb3eaa3c18f11244a"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="classXapian_1_1Registry.html#a2074a878db895c3fb3eaa3c18f11244a">More...</a><br /></td></tr>
<tr class="separator:a2074a878db895c3fb3eaa3c18f11244a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80ffccf647d842bcb7fae3a5d8361d1e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html#a80ffccf647d842bcb7fae3a5d8361d1e">register_weighting_scheme</a> (const <a class="el" href="classXapian_1_1Weight.html">Xapian::Weight</a> &wt)</td></tr>
<tr class="memdesc:a80ffccf647d842bcb7fae3a5d8361d1e"><td class="mdescLeft"> </td><td class="mdescRight">Register a weighting scheme. <a href="classXapian_1_1Registry.html#a80ffccf647d842bcb7fae3a5d8361d1e">More...</a><br /></td></tr>
<tr class="separator:a80ffccf647d842bcb7fae3a5d8361d1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b2c25527a163cf371be621902af33e7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1Weight.html">Xapian::Weight</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html#a1b2c25527a163cf371be621902af33e7">get_weighting_scheme</a> (const std::string &name) const</td></tr>
<tr class="memdesc:a1b2c25527a163cf371be621902af33e7"><td class="mdescLeft"> </td><td class="mdescRight">Get the weighting scheme given a name. <a href="classXapian_1_1Registry.html#a1b2c25527a163cf371be621902af33e7">More...</a><br /></td></tr>
<tr class="separator:a1b2c25527a163cf371be621902af33e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a265160ac28c20f73bb3c2063cacfbb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html#a3a265160ac28c20f73bb3c2063cacfbb">register_posting_source</a> (const <a class="el" href="classXapian_1_1PostingSource.html">Xapian::PostingSource</a> &source)</td></tr>
<tr class="memdesc:a3a265160ac28c20f73bb3c2063cacfbb"><td class="mdescLeft"> </td><td class="mdescRight">Register a user-defined posting source class. <a href="classXapian_1_1Registry.html#a3a265160ac28c20f73bb3c2063cacfbb">More...</a><br /></td></tr>
<tr class="separator:a3a265160ac28c20f73bb3c2063cacfbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aecab42ecc7eb8937191bcb350cebc0f9"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1PostingSource.html">Xapian::PostingSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html#aecab42ecc7eb8937191bcb350cebc0f9">get_posting_source</a> (const std::string &name) const</td></tr>
<tr class="memdesc:aecab42ecc7eb8937191bcb350cebc0f9"><td class="mdescLeft"> </td><td class="mdescRight">Get a posting source given a name. <a href="classXapian_1_1Registry.html#aecab42ecc7eb8937191bcb350cebc0f9">More...</a><br /></td></tr>
<tr class="separator:aecab42ecc7eb8937191bcb350cebc0f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8208e2ed2f5cceef6d5fa753d97c1690"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html#a8208e2ed2f5cceef6d5fa753d97c1690">register_match_spy</a> (const <a class="el" href="classXapian_1_1MatchSpy.html">Xapian::MatchSpy</a> &spy)</td></tr>
<tr class="memdesc:a8208e2ed2f5cceef6d5fa753d97c1690"><td class="mdescLeft"> </td><td class="mdescRight">Register a user-defined match spy class. <a href="classXapian_1_1Registry.html#a8208e2ed2f5cceef6d5fa753d97c1690">More...</a><br /></td></tr>
<tr class="separator:a8208e2ed2f5cceef6d5fa753d97c1690"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa68cdf4f269e63cf6c808db79dbedb6e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1MatchSpy.html">Xapian::MatchSpy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html#aa68cdf4f269e63cf6c808db79dbedb6e">get_match_spy</a> (const std::string &name) const</td></tr>
<tr class="memdesc:aa68cdf4f269e63cf6c808db79dbedb6e"><td class="mdescLeft"> </td><td class="mdescRight">Get a match spy given a name. <a href="classXapian_1_1Registry.html#aa68cdf4f269e63cf6c808db79dbedb6e">More...</a><br /></td></tr>
<tr class="separator:aa68cdf4f269e63cf6c808db79dbedb6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c7144d0a077baf966be6a88b98d8c0b"><td class="memItemLeft" align="right" valign="top"><a id="a1c7144d0a077baf966be6a88b98d8c0b" name="a1c7144d0a077baf966be6a88b98d8c0b"></a>
void </td><td class="memItemRight" valign="bottom"><b>register_lat_long_metric</b> (const <a class="el" href="classXapian_1_1LatLongMetric.html">Xapian::LatLongMetric</a> &metric)</td></tr>
<tr class="memdesc:a1c7144d0a077baf966be6a88b98d8c0b"><td class="mdescLeft"> </td><td class="mdescRight">Register a user-defined lat-long metric class. <br /></td></tr>
<tr class="separator:a1c7144d0a077baf966be6a88b98d8c0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd39dfe866f5763493b7a950e80544cc"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1LatLongMetric.html">Xapian::LatLongMetric</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Registry.html#acd39dfe866f5763493b7a950e80544cc">get_lat_long_metric</a> (const std::string &name) const</td></tr>
<tr class="memdesc:acd39dfe866f5763493b7a950e80544cc"><td class="mdescLeft"> </td><td class="mdescRight">Get a lat-long metric given a name. <a href="classXapian_1_1Registry.html#acd39dfe866f5763493b7a950e80544cc">More...</a><br /></td></tr>
<tr class="separator:acd39dfe866f5763493b7a950e80544cc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p ><a class="el" href="classXapian_1_1Registry.html" title="Registry for user subclasses.">Registry</a> for user subclasses. </p>
<p >This class provides a way for the remote server to look up user subclasses when unserialising. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a35540e2b99265677d41b8170c87ad3e6" name="a35540e2b99265677d41b8170c87ad3e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35540e2b99265677d41b8170c87ad3e6">◆ </a></span>Registry() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::Registry::Registry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Registry.html">Registry</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<p >The internals are reference counted, so copying is cheap.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The object to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2074a878db895c3fb3eaa3c18f11244a" name="a2074a878db895c3fb3eaa3c18f11244a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2074a878db895c3fb3eaa3c18f11244a">◆ </a></span>Registry() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::Registry::Registry </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p >The registry will contain all standard subclasses of user-subclassable classes. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acd39dfe866f5763493b7a950e80544cc" name="acd39dfe866f5763493b7a950e80544cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd39dfe866f5763493b7a950e80544cc">◆ </a></span>get_lat_long_metric()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXapian_1_1LatLongMetric.html">Xapian::LatLongMetric</a> * Xapian::Registry::get_lat_long_metric </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a lat-long metric given a name. </p>
<p >The returned metric is owned by the registry object.</p>
<p >Returns NULL if the metric could not be found. </p>
</div>
</div>
<a id="aa68cdf4f269e63cf6c808db79dbedb6e" name="aa68cdf4f269e63cf6c808db79dbedb6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa68cdf4f269e63cf6c808db79dbedb6e">◆ </a></span>get_match_spy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXapian_1_1MatchSpy.html">Xapian::MatchSpy</a> * Xapian::Registry::get_match_spy </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a match spy given a name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the match spy to find. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object with the requested name, or NULL if the match spy could not be found. The returned object is owned by the registry and so must not be deleted by the caller. </dd></dl>
</div>
</div>
<a id="aecab42ecc7eb8937191bcb350cebc0f9" name="aecab42ecc7eb8937191bcb350cebc0f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecab42ecc7eb8937191bcb350cebc0f9">◆ </a></span>get_posting_source()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXapian_1_1PostingSource.html">Xapian::PostingSource</a> * Xapian::Registry::get_posting_source </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a posting source given a name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the posting source to find. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object with the requested name, or NULL if the posting source could not be found. The returned object is owned by the registry and so must not be deleted by the caller. </dd></dl>
</div>
</div>
<a id="a1b2c25527a163cf371be621902af33e7" name="a1b2c25527a163cf371be621902af33e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b2c25527a163cf371be621902af33e7">◆ </a></span>get_weighting_scheme()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXapian_1_1Weight.html">Xapian::Weight</a> * Xapian::Registry::get_weighting_scheme </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the weighting scheme given a name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the weighting scheme to find. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object with the requested name, or NULL if the weighting scheme could not be found. The returned object is owned by the registry and so must not be deleted by the caller. </dd></dl>
</div>
</div>
<a id="a954e19523b2584fcc8b5f0df2da30424" name="a954e19523b2584fcc8b5f0df2da30424"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a954e19523b2584fcc8b5f0df2da30424">◆ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1Registry.html">Registry</a> & Xapian::Registry::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Registry.html">Registry</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<p >The internals are reference counted, so assignment is cheap.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The object to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8208e2ed2f5cceef6d5fa753d97c1690" name="a8208e2ed2f5cceef6d5fa753d97c1690"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8208e2ed2f5cceef6d5fa753d97c1690">◆ </a></span>register_match_spy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Registry::register_match_spy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MatchSpy.html">Xapian::MatchSpy</a> & </td>
<td class="paramname"><em>spy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a user-defined match spy class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">spy</td><td>The match spy to register. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3a265160ac28c20f73bb3c2063cacfbb" name="a3a265160ac28c20f73bb3c2063cacfbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a265160ac28c20f73bb3c2063cacfbb">◆ </a></span>register_posting_source()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Registry::register_posting_source </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1PostingSource.html">Xapian::PostingSource</a> & </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a user-defined posting source class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The posting source to register. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a80ffccf647d842bcb7fae3a5d8361d1e" name="a80ffccf647d842bcb7fae3a5d8361d1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80ffccf647d842bcb7fae3a5d8361d1e">◆ </a></span>register_weighting_scheme()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Registry::register_weighting_scheme </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Weight.html">Xapian::Weight</a> & </td>
<td class="paramname"><em>wt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a weighting scheme. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">wt</td><td>The weighting scheme to register. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="registry_8h.html">registry.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>
|
