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
|
<!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::NumberRangeProcessor 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_1NumberRangeProcessor.html">NumberRangeProcessor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1NumberRangeProcessor-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Xapian::NumberRangeProcessor Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Handle a number range.
<a href="classXapian_1_1NumberRangeProcessor.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::NumberRangeProcessor:</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_1NumberRangeProcessor__inherit__graph.png" border="0" usemap="#aXapian_1_1NumberRangeProcessor_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1NumberRangeProcessor_inherit__map" id="aXapian_1_1NumberRangeProcessor_inherit__map">
<area shape="rect" title="Handle a number range." alt="" coords="5,169,236,196"/>
<area shape="rect" href="classXapian_1_1RangeProcessor.html" title="Base class for range processors." alt="" coords="31,95,210,121"/>
<area shape="rect" title=" " alt="" coords="43,5,198,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:a9a780b0429428be60c730313c8f79ad1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1NumberRangeProcessor.html#a9a780b0429428be60c730313c8f79ad1">NumberRangeProcessor</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const std::string &str_=std::string(), unsigned flags_=0)</td></tr>
<tr class="memdesc:a9a780b0429428be60c730313c8f79ad1"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classXapian_1_1NumberRangeProcessor.html#a9a780b0429428be60c730313c8f79ad1">More...</a><br /></td></tr>
<tr class="separator:a9a780b0429428be60c730313c8f79ad1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a063f5f3d767c09f0daab303de96fdfc7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Query.html">Xapian::Query</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1NumberRangeProcessor.html#a063f5f3d767c09f0daab303de96fdfc7">operator()</a> (const std::string &begin, const std::string &end)</td></tr>
<tr class="memdesc:a063f5f3d767c09f0daab303de96fdfc7"><td class="mdescLeft"> </td><td class="mdescRight">Check for a valid numeric range. <a href="classXapian_1_1NumberRangeProcessor.html#a063f5f3d767c09f0daab303de96fdfc7">More...</a><br /></td></tr>
<tr class="separator:a063f5f3d767c09f0daab303de96fdfc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1RangeProcessor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1RangeProcessor')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXapian_1_1RangeProcessor.html">Xapian::RangeProcessor</a></td></tr>
<tr class="memitem:afa529885bf1654cfacb0d5df37431852 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memItemLeft" align="right" valign="top"><a id="afa529885bf1654cfacb0d5df37431852" name="afa529885bf1654cfacb0d5df37431852"></a>
 </td><td class="memItemRight" valign="bottom"><b>RangeProcessor</b> ()</td></tr>
<tr class="memdesc:afa529885bf1654cfacb0d5df37431852 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:afa529885bf1654cfacb0d5df37431852 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca78f2633f761f70a2e94e62e741f0ba inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RangeProcessor.html#aca78f2633f761f70a2e94e62e741f0ba">RangeProcessor</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const std::string &str_=std::string(), unsigned flags_=0)</td></tr>
<tr class="memdesc:aca78f2633f761f70a2e94e62e741f0ba inherit pub_methods_classXapian_1_1RangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classXapian_1_1RangeProcessor.html#aca78f2633f761f70a2e94e62e741f0ba">More...</a><br /></td></tr>
<tr class="separator:aca78f2633f761f70a2e94e62e741f0ba inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e4e5a0afdabcb3fb57757518d95f5f1 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memItemLeft" align="right" valign="top"><a id="a8e4e5a0afdabcb3fb57757518d95f5f1" name="a8e4e5a0afdabcb3fb57757518d95f5f1"></a>
virtual </td><td class="memItemRight" valign="bottom"><b>~RangeProcessor</b> ()</td></tr>
<tr class="memdesc:a8e4e5a0afdabcb3fb57757518d95f5f1 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a8e4e5a0afdabcb3fb57757518d95f5f1 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a480be06c8508458ca90409265175d1b1 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Query.html">Xapian::Query</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RangeProcessor.html#a480be06c8508458ca90409265175d1b1">check_range</a> (const std::string &b, const std::string &e)</td></tr>
<tr class="memdesc:a480be06c8508458ca90409265175d1b1 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Check prefix/suffix on range. <a href="classXapian_1_1RangeProcessor.html#a480be06c8508458ca90409265175d1b1">More...</a><br /></td></tr>
<tr class="separator:a480be06c8508458ca90409265175d1b1 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e84753e4553ae7515edb4ef12da55b0 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXapian_1_1Query.html">Xapian::Query</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RangeProcessor.html#a4e84753e4553ae7515edb4ef12da55b0">operator()</a> (const std::string &begin, const std::string &end)</td></tr>
<tr class="memdesc:a4e84753e4553ae7515edb4ef12da55b0 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Check for a valid range of this type. <a href="classXapian_1_1RangeProcessor.html#a4e84753e4553ae7515edb4ef12da55b0">More...</a><br /></td></tr>
<tr class="separator:a4e84753e4553ae7515edb4ef12da55b0 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57c6657f62cc9cf2f6fadd2c65c8d8c1 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1RangeProcessor.html">RangeProcessor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RangeProcessor.html#a57c6657f62cc9cf2f6fadd2c65c8d8c1">release</a> ()</td></tr>
<tr class="memdesc:a57c6657f62cc9cf2f6fadd2c65c8d8c1 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1RangeProcessor.html#a57c6657f62cc9cf2f6fadd2c65c8d8c1">More...</a><br /></td></tr>
<tr class="separator:a57c6657f62cc9cf2f6fadd2c65c8d8c1 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a9586441f589b14156d8f30c2178cb5 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1RangeProcessor.html">RangeProcessor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RangeProcessor.html#a2a9586441f589b14156d8f30c2178cb5">release</a> () const</td></tr>
<tr class="memdesc:a2a9586441f589b14156d8f30c2178cb5 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1RangeProcessor.html#a2a9586441f589b14156d8f30c2178cb5">More...</a><br /></td></tr>
<tr class="separator:a2a9586441f589b14156d8f30c2178cb5 inherit pub_methods_classXapian_1_1RangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classXapian_1_1RangeProcessor"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classXapian_1_1RangeProcessor')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classXapian_1_1RangeProcessor.html">Xapian::RangeProcessor</a></td></tr>
<tr class="memitem:acecd504902d023c15c7ee070b5b986cc inherit pro_attribs_classXapian_1_1RangeProcessor"><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_1RangeProcessor.html#acecd504902d023c15c7ee070b5b986cc">slot</a></td></tr>
<tr class="memdesc:acecd504902d023c15c7ee070b5b986cc inherit pro_attribs_classXapian_1_1RangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">The value slot to process. <a href="classXapian_1_1RangeProcessor.html#acecd504902d023c15c7ee070b5b986cc">More...</a><br /></td></tr>
<tr class="separator:acecd504902d023c15c7ee070b5b986cc inherit pro_attribs_classXapian_1_1RangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6e146d4853c71fbcfebf82d97756a5d inherit pro_attribs_classXapian_1_1RangeProcessor"><td class="memItemLeft" align="right" valign="top"><a id="ac6e146d4853c71fbcfebf82d97756a5d" name="ac6e146d4853c71fbcfebf82d97756a5d"></a>
std::string </td><td class="memItemRight" valign="bottom"><b>str</b></td></tr>
<tr class="memdesc:ac6e146d4853c71fbcfebf82d97756a5d inherit pro_attribs_classXapian_1_1RangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">The prefix (or suffix with RP_SUFFIX) string to look for. <br /></td></tr>
<tr class="separator:ac6e146d4853c71fbcfebf82d97756a5d inherit pro_attribs_classXapian_1_1RangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b4f9b87b07a0bbd54bd019751dd97ef inherit pro_attribs_classXapian_1_1RangeProcessor"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RangeProcessor.html#a0b4f9b87b07a0bbd54bd019751dd97ef">flags</a></td></tr>
<tr class="memdesc:a0b4f9b87b07a0bbd54bd019751dd97ef inherit pro_attribs_classXapian_1_1RangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Flags. <a href="classXapian_1_1RangeProcessor.html#a0b4f9b87b07a0bbd54bd019751dd97ef">More...</a><br /></td></tr>
<tr class="separator:a0b4f9b87b07a0bbd54bd019751dd97ef inherit pro_attribs_classXapian_1_1RangeProcessor"><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 number range. </p>
<p >This class must be used on values which have been encoded using <a class="el" href="namespaceXapian.html#a29a741b4cda98e10ed5f2fc784039065" title="Convert a floating point number to a string, preserving sort order.">Xapian::sortable_serialise()</a> which turns numbers into strings which will sort in the same order as the numbers (the same values can be used to implement a numeric sort). </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a9a780b0429428be60c730313c8f79ad1" name="a9a780b0429428be60c730313c8f79ad1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a780b0429428be60c730313c8f79ad1">◆ </a></span>NumberRangeProcessor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::NumberRangeProcessor::NumberRangeProcessor </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> = <code>std::string()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>flags_</em> = <code>0</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 slot number to query.</td></tr>
<tr><td class="paramname">str_</td><td>A string to look for to recognise values as belonging to this numeric range.</td></tr>
<tr><td class="paramname">flags_</td><td>Zero or more of the following flags, combined with bitwise-or:<ul>
<li>Xapian::RP_SUFFIX - require <em>str_</em> as a suffix instead of a prefix.</li>
<li>Xapian::RP_REPEATED - optionally allow <em>str_</em> on both ends of the range - e.g. $1..$10 or 5m..50m. By default a prefix is only checked for on the start (e.g. date:1/1/1980..31/12/1989), and a suffix only on the end (e.g. 2..12kg).</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p>The string supplied in str_ is used by <em>operator()</em> to decide whether the pair of strings supplied to it constitute a valid range. If prefix_ is true, the first value in a range must begin with str_ (and the second value may optionally begin with str_); if prefix_ is false, the second value in a range must end with str_ (and the first value may optionally end with str_).</p>
<p >If str_ is empty, the setting of prefix_ is irrelevant, and no special strings are required at the start or end of the strings defining the range.</p>
<p >The remainder of both strings defining the endpoints must be valid floating point numbers. (FIXME: define format recognised).</p>
<p >For example, if str_ is "$" and prefix_ is true, and the range processor has been added to the queryparser, the queryparser will accept "$10..50" or "$10..$50", but not "10..50" or "10..$50" as valid ranges. If str_ is "kg" and prefix_ is false, the queryparser will accept "10..50kg" or "10kg..50kg", but not "10..50" or "10kg..50" as valid ranges. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a063f5f3d767c09f0daab303de96fdfc7" name="a063f5f3d767c09f0daab303de96fdfc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a063f5f3d767c09f0daab303de96fdfc7">◆ </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="classXapian_1_1Query.html">Xapian::Query</a> Xapian::NumberRangeProcessor::operator() </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const 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 numeric range. </p>
<p >If BEGIN..END is a valid numeric range with the specified prefix/suffix (if one was specified), the prefix/suffix is removed, the string converted to a number, and encoded with <a class="el" href="namespaceXapian.html#a29a741b4cda98e10ed5f2fc784039065" title="Convert a floating point number to a string, preserving sort order.">Xapian::sortable_serialise()</a>, and a value range query is built.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">begin</td><td>The start of the range as specified in the query string by the user. </td></tr>
<tr><td class="paramname">end</td><td>The end of the range as specified in the query string by the user. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classXapian_1_1RangeProcessor.html#a4e84753e4553ae7515edb4ef12da55b0">Xapian::RangeProcessor</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>
|
