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 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
|
<!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::DateValueRangeProcessor 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_1DateValueRangeProcessor.html">DateValueRangeProcessor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1DateValueRangeProcessor-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Xapian::DateValueRangeProcessor Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Handle a date range.
<a href="classXapian_1_1DateValueRangeProcessor.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::DateValueRangeProcessor:</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_1DateValueRangeProcessor__inherit__graph.png" border="0" usemap="#aXapian_1_1DateValueRangeProcessor_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1DateValueRangeProcessor_inherit__map" id="aXapian_1_1DateValueRangeProcessor_inherit__map">
<area shape="rect" title="Handle a date range." alt="" coords="5,259,252,285"/>
<area shape="rect" href="classXapian_1_1StringValueRangeProcessor.html" title="Handle a string range." alt="" coords="33,169,224,211"/>
<area shape="rect" href="classXapian_1_1ValueRangeProcessor.html" title="Base class for value range processors." alt="" coords="21,95,237,121"/>
<area shape="rect" title=" " alt="" coords="51,5,206,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:adfec2564921b21c35bd72c63d1793745"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DateValueRangeProcessor.html#adfec2564921b21c35bd72c63d1793745">DateValueRangeProcessor</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, bool prefer_mdy_=false, int epoch_year_=1970)</td></tr>
<tr class="memdesc:adfec2564921b21c35bd72c63d1793745"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classXapian_1_1DateValueRangeProcessor.html#adfec2564921b21c35bd72c63d1793745">More...</a><br /></td></tr>
<tr class="separator:adfec2564921b21c35bd72c63d1793745"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca14923c4886029ac19f96ea145ede38"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DateValueRangeProcessor.html#aca14923c4886029ac19f96ea145ede38">DateValueRangeProcessor</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const std::string &str_, bool prefix_=true, bool prefer_mdy_=false, int epoch_year_=1970)</td></tr>
<tr class="memdesc:aca14923c4886029ac19f96ea145ede38"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classXapian_1_1DateValueRangeProcessor.html#aca14923c4886029ac19f96ea145ede38">More...</a><br /></td></tr>
<tr class="separator:aca14923c4886029ac19f96ea145ede38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4dddb81b7bcee77670d615896cbd1331"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1DateValueRangeProcessor.html#a4dddb81b7bcee77670d615896cbd1331">DateValueRangeProcessor</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const char *str_, bool prefix_=true, bool prefer_mdy_=false, int epoch_year_=1970)</td></tr>
<tr class="memdesc:a4dddb81b7bcee77670d615896cbd1331"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classXapian_1_1DateValueRangeProcessor.html#a4dddb81b7bcee77670d615896cbd1331">More...</a><br /></td></tr>
<tr class="separator:a4dddb81b7bcee77670d615896cbd1331"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29c079d9156a872f38fca82195525a92"><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_1DateValueRangeProcessor.html#a29c079d9156a872f38fca82195525a92">operator()</a> (std::string &begin, std::string &end)</td></tr>
<tr class="memdesc:a29c079d9156a872f38fca82195525a92"><td class="mdescLeft"> </td><td class="mdescRight">Check for a valid date range. <a href="classXapian_1_1DateValueRangeProcessor.html#a29c079d9156a872f38fca82195525a92">More...</a><br /></td></tr>
<tr class="separator:a29c079d9156a872f38fca82195525a92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1StringValueRangeProcessor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1StringValueRangeProcessor')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXapian_1_1StringValueRangeProcessor.html">Xapian::StringValueRangeProcessor</a></td></tr>
<tr class="memitem:a5601dd9129f9b21e7b973881bb4a2187 inherit pub_methods_classXapian_1_1StringValueRangeProcessor"><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 inherit pub_methods_classXapian_1_1StringValueRangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classXapian_1_1StringValueRangeProcessor.html#a5601dd9129f9b21e7b973881bb4a2187">More...</a><br /></td></tr>
<tr class="separator:a5601dd9129f9b21e7b973881bb4a2187 inherit pub_methods_classXapian_1_1StringValueRangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0f051c154c1395b0fbd0834df102c4f inherit pub_methods_classXapian_1_1StringValueRangeProcessor"><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 inherit pub_methods_classXapian_1_1StringValueRangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classXapian_1_1StringValueRangeProcessor.html#ae0f051c154c1395b0fbd0834df102c4f">More...</a><br /></td></tr>
<tr class="separator:ae0f051c154c1395b0fbd0834df102c4f inherit pub_methods_classXapian_1_1StringValueRangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac2cd6bf4645a3bb242cf5ad5022ae5e inherit pub_methods_classXapian_1_1StringValueRangeProcessor"><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 inherit pub_methods_classXapian_1_1StringValueRangeProcessor"><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 inherit pub_methods_classXapian_1_1StringValueRangeProcessor"><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="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classXapian_1_1StringValueRangeProcessor"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classXapian_1_1StringValueRangeProcessor')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classXapian_1_1StringValueRangeProcessor.html">Xapian::StringValueRangeProcessor</a></td></tr>
<tr class="memitem:a62b1ae7a770c8fce5be0636204e7a493 inherit pro_attribs_classXapian_1_1StringValueRangeProcessor"><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 inherit pro_attribs_classXapian_1_1StringValueRangeProcessor"><td class="mdescLeft"> </td><td class="mdescRight">The value slot to process. <br /></td></tr>
<tr class="separator:a62b1ae7a770c8fce5be0636204e7a493 inherit pro_attribs_classXapian_1_1StringValueRangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4da1c8b8599b6b498987ace264af5d2 inherit pro_attribs_classXapian_1_1StringValueRangeProcessor"><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 inherit pro_attribs_classXapian_1_1StringValueRangeProcessor"><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 inherit pro_attribs_classXapian_1_1StringValueRangeProcessor"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0d2d28f922f003a6a6a22e15274130a inherit pro_attribs_classXapian_1_1StringValueRangeProcessor"><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 inherit pro_attribs_classXapian_1_1StringValueRangeProcessor"><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 inherit pro_attribs_classXapian_1_1StringValueRangeProcessor"><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 date range. </p>
<p >Begin and end must be dates in a recognised format.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000012">Deprecated:</a></b></dt><dd>Use <a class="el" href="classXapian_1_1DateRangeProcessor.html" title="Handle a date range.">Xapian::DateRangeProcessor</a> instead (added in 1.3.6). </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="adfec2564921b21c35bd72c63d1793745" name="adfec2564921b21c35bd72c63d1793745"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfec2564921b21c35bd72c63d1793745">◆ </a></span>DateValueRangeProcessor() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::DateValueRangeProcessor::DateValueRangeProcessor </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">bool </td>
<td class="paramname"><em>prefer_mdy_</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>epoch_year_</em> = <code>1970</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">prefer_mdy_</td><td>Should ambiguous dates be interpreted as month/day/year rather than day/month/year? (default: false) </td></tr>
<tr><td class="paramname">epoch_year_</td><td>Year to use as the epoch for dates with 2 digit years (default: 1970, so 1/1/69 is 2069 while 1/1/70 is 1970). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aca14923c4886029ac19f96ea145ede38" name="aca14923c4886029ac19f96ea145ede38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca14923c4886029ac19f96ea145ede38">◆ </a></span>DateValueRangeProcessor() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::DateValueRangeProcessor::DateValueRangeProcessor </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 class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>prefer_mdy_</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>epoch_year_</em> = <code>1970</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 date range.</td></tr>
<tr><td class="paramname">prefix_</td><td>Whether to look for the string at the start or end of the values. If true, the string is a prefix; if false, the string is a suffix (default: true).</td></tr>
<tr><td class="paramname">prefer_mdy_</td><td>Should ambiguous dates be interpreted as month/day/year rather than day/month/year? (default: false)</td></tr>
<tr><td class="paramname">epoch_year_</td><td>Year to use as the epoch for dates with 2 digit years (default: 1970, so 1/1/69 is 2069 while 1/1/70 is 1970).</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 dates.</p>
<p >For example, if str_ is "created:" and prefix_ is true, and the range processor has been added to the queryparser, the queryparser will accept "created:1/1/2000..31/12/2001". </p>
</div>
</div>
<a id="a4dddb81b7bcee77670d615896cbd1331" name="a4dddb81b7bcee77670d615896cbd1331"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4dddb81b7bcee77670d615896cbd1331">◆ </a></span>DateValueRangeProcessor() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::DateValueRangeProcessor::DateValueRangeProcessor </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 char * </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 class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>prefer_mdy_</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>epoch_year_</em> = <code>1970</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>
<p >This is like the previous version, but with const char * instead of std::string - we need this overload as otherwise <a class="el" href="classXapian_1_1DateValueRangeProcessor.html" title="Handle a date range.">DateValueRangeProcessor</a>(1, "date:") quietly interprets the second argument as a boolean in preference to std::string. If you want to be compatible with 1.2.12 and earlier, then explicitly convert to std::string, i.e.: <a class="el" href="classXapian_1_1DateValueRangeProcessor.html" title="Handle a date range.">DateValueRangeProcessor</a>(1, std::string("date:"))</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 date range.</td></tr>
<tr><td class="paramname">prefix_</td><td>Whether to look for the string at the start or end of the values. If true, the string is a prefix; if false, the string is a suffix (default: true).</td></tr>
<tr><td class="paramname">prefer_mdy_</td><td>Should ambiguous dates be interpreted as month/day/year rather than day/month/year? (default: false)</td></tr>
<tr><td class="paramname">epoch_year_</td><td>Year to use as the epoch for dates with 2 digit years (default: 1970, so 1/1/69 is 2069 while 1/1/70 is 1970).</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 dates.</p>
<p >For example, if str_ is "created:" and prefix_ is true, and the range processor has been added to the queryparser, the queryparser will accept "created:1/1/2000..31/12/2001". </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a29c079d9156a872f38fca82195525a92" name="a29c079d9156a872f38fca82195525a92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29c079d9156a872f38fca82195525a92">◆ </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::DateValueRangeProcessor::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 date 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>If BEGIN..END is a sensible date range, this method modifies them into the format YYYYMMDD and returns the value of slot_ passed at construction time. Otherwise it returns <a class="el" href="namespaceXapian.html#a0a75ef120e641c77f703e60f595ffda2" title="Reserved value to indicate "no valueno".">Xapian::BAD_VALUENO</a>. </dd></dl>
<p>Reimplemented from <a class="el" href="classXapian_1_1StringValueRangeProcessor.html#aac2cd6bf4645a3bb242cf5ad5022ae5e">Xapian::StringValueRangeProcessor</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>
|