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
|
<!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::StringValueRangeProcessor 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_1StringValueRangeProcessor.html">StringValueRangeProcessor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classXapian_1_1StringValueRangeProcessor-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Xapian::StringValueRangeProcessor Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Handle a string range.
<a href="classXapian_1_1StringValueRangeProcessor.html#details">More...</a></p>
<p><code>#include <queryparser.h></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::StringValueRangeProcessor:</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_1StringValueRangeProcessor__inherit__graph.png" border="0" usemap="#aXapian_1_1StringValueRangeProcessor_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1StringValueRangeProcessor_inherit__map" id="aXapian_1_1StringValueRangeProcessor_inherit__map">
<area shape="rect" title="Handle a string range." alt="" coords="159,169,349,211"/>
<area shape="rect" href="classXapian_1_1DateValueRangeProcessor.html" title="Handle a date range." alt="" coords="5,266,252,293"/>
<area shape="rect" href="classXapian_1_1NumberValueRangeProcessor.html" title="Handle a number range." alt="" coords="277,259,482,300"/>
<area shape="rect" href="classXapian_1_1ValueRangeProcessor.html" title="Base class for value range processors." alt="" coords="146,95,362,121"/>
<area shape="rect" title=" " alt="" coords="177,5,331,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:a5601dd9129f9b21e7b973881bb4a2187"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1StringValueRangeProcessor.html#a5601dd9129f9b21e7b973881bb4a2187">StringValueRangeProcessor</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_)</td></tr>
<tr class="memdesc:a5601dd9129f9b21e7b973881bb4a2187"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classXapian_1_1StringValueRangeProcessor.html#a5601dd9129f9b21e7b973881bb4a2187">More...</a><br /></td></tr>
<tr class="separator:a5601dd9129f9b21e7b973881bb4a2187"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0f051c154c1395b0fbd0834df102c4f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1StringValueRangeProcessor.html#ae0f051c154c1395b0fbd0834df102c4f">StringValueRangeProcessor</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const std::string &str_, bool prefix_=true)</td></tr>
<tr class="memdesc:ae0f051c154c1395b0fbd0834df102c4f"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classXapian_1_1StringValueRangeProcessor.html#ae0f051c154c1395b0fbd0834df102c4f">More...</a><br /></td></tr>
<tr class="separator:ae0f051c154c1395b0fbd0834df102c4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac2cd6bf4645a3bb242cf5ad5022ae5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1StringValueRangeProcessor.html#aac2cd6bf4645a3bb242cf5ad5022ae5e">operator()</a> (std::string &begin, std::string &end)</td></tr>
<tr class="memdesc:aac2cd6bf4645a3bb242cf5ad5022ae5e"><td class="mdescLeft"> </td><td class="mdescRight">Check for a valid string range. <a href="classXapian_1_1StringValueRangeProcessor.html#aac2cd6bf4645a3bb242cf5ad5022ae5e">More...</a><br /></td></tr>
<tr class="separator:aac2cd6bf4645a3bb242cf5ad5022ae5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1ValueRangeProcessor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1ValueRangeProcessor')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXapian_1_1ValueRangeProcessor.html">Xapian::ValueRangeProcessor</a></td></tr>
<tr class="memitem:a49c2fa240e0d3651efce6dce881f09d7 inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="memItemLeft" align="right" valign="top"><a id="a49c2fa240e0d3651efce6dce881f09d7" name="a49c2fa240e0d3651efce6dce881f09d7"></a>
 </td><td class="memItemRight" valign="bottom"><b>ValueRangeProcessor</b> ()</td></tr>
<tr class="memdesc:a49c2fa240e0d3651efce6dce881f09d7 inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a49c2fa240e0d3651efce6dce881f09d7 inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab32baad9238adb002b47f99ec362e56e inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="memItemLeft" align="right" valign="top"><a id="ab32baad9238adb002b47f99ec362e56e" name="ab32baad9238adb002b47f99ec362e56e"></a>
virtual </td><td class="memItemRight" valign="bottom"><b>~ValueRangeProcessor</b> ()</td></tr>
<tr class="memdesc:ab32baad9238adb002b47f99ec362e56e inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ab32baad9238adb002b47f99ec362e56e inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa04e11c41e40ceed5f796c94348d2ad2 inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueRangeProcessor.html#aa04e11c41e40ceed5f796c94348d2ad2">operator()</a> (std::string &begin, std::string &end)=0</td></tr>
<tr class="memdesc:aa04e11c41e40ceed5f796c94348d2ad2 inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Check for a valid range of this type. <a href="classXapian_1_1ValueRangeProcessor.html#aa04e11c41e40ceed5f796c94348d2ad2">More...</a><br /></td></tr>
<tr class="separator:aa04e11c41e40ceed5f796c94348d2ad2 inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab175aa10d748a76b0a3fb093601a5b61 inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ValueRangeProcessor.html">ValueRangeProcessor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueRangeProcessor.html#ab175aa10d748a76b0a3fb093601a5b61">release</a> ()</td></tr>
<tr class="memdesc:ab175aa10d748a76b0a3fb093601a5b61 inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1ValueRangeProcessor.html#ab175aa10d748a76b0a3fb093601a5b61">More...</a><br /></td></tr>
<tr class="separator:ab175aa10d748a76b0a3fb093601a5b61 inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4481d7ffedbac20f7632abd96a095fb inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1ValueRangeProcessor.html">ValueRangeProcessor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueRangeProcessor.html#ab4481d7ffedbac20f7632abd96a095fb">release</a> () const</td></tr>
<tr class="memdesc:ab4481d7ffedbac20f7632abd96a095fb inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1ValueRangeProcessor.html#ab4481d7ffedbac20f7632abd96a095fb">More...</a><br /></td></tr>
<tr class="separator:ab4481d7ffedbac20f7632abd96a095fb inherit pub_methods_classXapian_1_1ValueRangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a62b1ae7a770c8fce5be0636204e7a493"><td class="memItemLeft" align="right" valign="top"><a id="a62b1ae7a770c8fce5be0636204e7a493" name="a62b1ae7a770c8fce5be0636204e7a493"></a>
<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td><td class="memItemRight" valign="bottom"><b>valno</b></td></tr>
<tr class="memdesc:a62b1ae7a770c8fce5be0636204e7a493"><td class="mdescLeft"> </td><td class="mdescRight">The value slot to process. <br /></td></tr>
<tr class="separator:a62b1ae7a770c8fce5be0636204e7a493"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4da1c8b8599b6b498987ace264af5d2"><td class="memItemLeft" align="right" valign="top"><a id="ab4da1c8b8599b6b498987ace264af5d2" name="ab4da1c8b8599b6b498987ace264af5d2"></a>
bool </td><td class="memItemRight" valign="bottom"><b>prefix</b></td></tr>
<tr class="memdesc:ab4da1c8b8599b6b498987ace264af5d2"><td class="mdescLeft"> </td><td class="mdescRight">Whether to look for <em>str</em> as a prefix or suffix. <br /></td></tr>
<tr class="separator:ab4da1c8b8599b6b498987ace264af5d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0d2d28f922f003a6a6a22e15274130a"><td class="memItemLeft" align="right" valign="top"><a id="ad0d2d28f922f003a6a6a22e15274130a" name="ad0d2d28f922f003a6a6a22e15274130a"></a>
std::string </td><td class="memItemRight" valign="bottom"><b>str</b></td></tr>
<tr class="memdesc:ad0d2d28f922f003a6a6a22e15274130a"><td class="mdescLeft"> </td><td class="mdescRight">The prefix (or suffix if prefix==false) string to look for. <br /></td></tr>
<tr class="separator:ad0d2d28f922f003a6a6a22e15274130a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Handle a string range. </p>
<p >The end points can be any strings.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd>Use <a class="el" href="classXapian_1_1RangeProcessor.html" title="Base class for range processors.">Xapian::RangeProcessor</a> instead (added in 1.3.6). </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a5601dd9129f9b21e7b973881bb4a2187" name="a5601dd9129f9b21e7b973881bb4a2187"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5601dd9129f9b21e7b973881bb4a2187">◆ </a></span>StringValueRangeProcessor() <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">Xapian::StringValueRangeProcessor::StringValueRangeProcessor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>slot_</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot_</td><td>The value number to return from operator(). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae0f051c154c1395b0fbd0834df102c4f" name="ae0f051c154c1395b0fbd0834df102c4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0f051c154c1395b0fbd0834df102c4f">◆ </a></span>StringValueRangeProcessor() <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">Xapian::StringValueRangeProcessor::StringValueRangeProcessor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>slot_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>str_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>prefix_</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot_</td><td>The value number to return from operator(). </td></tr>
<tr><td class="paramname">str_</td><td>A string to look for to recognise values as belonging to this range. </td></tr>
<tr><td class="paramname">prefix_</td><td>Flag specifying whether to check for str_ as a prefix or a suffix. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aac2cd6bf4645a3bb242cf5ad5022ae5e" name="aac2cd6bf4645a3bb242cf5ad5022ae5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac2cd6bf4645a3bb242cf5ad5022ae5e">◆ </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"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> Xapian::StringValueRangeProcessor::operator() </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>end</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Check for a valid string range. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">begin</td><td>The start of the range as specified in the query string by the user. This parameter is a non-const reference so the <a class="el" href="classXapian_1_1ValueRangeProcessor.html" title="Base class for value range processors.">ValueRangeProcessor</a> can modify it to return the value to start the range with. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">end</td><td>The end of the range. This is also a non-const reference so it can be modified.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classXapian_1_1StringValueRangeProcessor.html" title="Handle a string range.">StringValueRangeProcessor</a> always accepts a range it is offered, and returns the value of slot_ passed at construction time. It doesn't modify <em>begin</em> or <em>end</em>. </dd></dl>
<p>Implements <a class="el" href="classXapian_1_1ValueRangeProcessor.html#aa04e11c41e40ceed5f796c94348d2ad2">Xapian::ValueRangeProcessor</a>.</p>
<p>Reimplemented in <a class="el" href="classXapian_1_1DateValueRangeProcessor.html#a29c079d9156a872f38fca82195525a92">Xapian::DateValueRangeProcessor</a>, and <a class="el" href="classXapian_1_1NumberValueRangeProcessor.html#a4a0951e57a4ea8fcdcd9bec6a8037514">Xapian::NumberValueRangeProcessor</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="queryparser_8h.html">queryparser.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>
|
