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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>LCOV - lcov.info - /usr/include/xapian/query.h</title>
<link rel="stylesheet" type="text/css" href="../../../gcov.css">
</head>
<body>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="title">LTP GCOV extension - code coverage report</td></tr>
<tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr>
<tr>
<td width="100%">
<table cellpadding=1 border=0 width="100%">
<tr>
<td class="headerItem" width="20%">Current view:</td>
<td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - query.h</td>
</tr>
<tr>
<td class="headerItem" width="20%">Test:</td>
<td class="headerValue" width="80%" colspan=4>lcov.info</td>
</tr>
<tr>
<td class="headerItem" width="20%">Date:</td>
<td class="headerValue" width="20%">2008-08-14</td>
<td width="20%"></td>
<td class="headerItem" width="20%">Instrumented lines:</td>
<td class="headerValue" width="20%">11</td>
</tr>
<tr>
<td class="headerItem" width="20%">Code covered:</td>
<td class="headerValue" width="20%">72.7 %</td>
<td width="20%"></td>
<td class="headerItem" width="20%">Executed lines:</td>
<td class="headerValue" width="20%">8</td>
</tr>
</table>
</td>
</tr>
<tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr>
</table>
<table cellpadding=0 cellspacing=0 border=0>
<tr>
<td><br></td>
</tr>
<tr>
<td><pre class="source">
<span class="lineNum"> 1 </span> : /** \file query.h
<span class="lineNum"> 2 </span> : * \brief Classes for representing a query
<span class="lineNum"> 3 </span> : */
<span class="lineNum"> 4 </span> : /* Copyright 1999,2000,2001 BrightStation PLC
<span class="lineNum"> 5 </span> : * Copyright 2002 Ananova Ltd
<span class="lineNum"> 6 </span> : * Copyright 2003,2004,2005,2006,2007 Olly Betts
<span class="lineNum"> 7 </span> : * Copyright 2006,2007,2008 Lemur Consulting Ltd
<span class="lineNum"> 8 </span> : *
<span class="lineNum"> 9 </span> : * This program is free software; you can redistribute it and/or
<span class="lineNum"> 10 </span> : * modify it under the terms of the GNU General Public License as
<span class="lineNum"> 11 </span> : * published by the Free Software Foundation; either version 2 of the
<span class="lineNum"> 12 </span> : * License, or (at your option) any later version.
<span class="lineNum"> 13 </span> : *
<span class="lineNum"> 14 </span> : * This program is distributed in the hope that it will be useful,
<span class="lineNum"> 15 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of
<span class="lineNum"> 16 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<span class="lineNum"> 17 </span> : * GNU General Public License for more details.
<span class="lineNum"> 18 </span> : *
<span class="lineNum"> 19 </span> : * You should have received a copy of the GNU General Public License
<span class="lineNum"> 20 </span> : * along with this program; if not, write to the Free Software
<span class="lineNum"> 21 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
<span class="lineNum"> 22 </span> : * USA
<span class="lineNum"> 23 </span> : */
<span class="lineNum"> 24 </span> :
<span class="lineNum"> 25 </span> : #ifndef XAPIAN_INCLUDED_QUERY_H
<span class="lineNum"> 26 </span> : #define XAPIAN_INCLUDED_QUERY_H
<span class="lineNum"> 27 </span> :
<span class="lineNum"> 28 </span> : #include <string>
<span class="lineNum"> 29 </span> : #include <vector>
<span class="lineNum"> 30 </span> :
<span class="lineNum"> 31 </span> : #include <xapian/base.h>
<span class="lineNum"> 32 </span> : #include <xapian/deprecated.h>
<span class="lineNum"> 33 </span> : #include <xapian/types.h>
<span class="lineNum"> 34 </span> : #include <xapian/termiterator.h>
<span class="lineNum"> 35 </span> : #include <xapian/visibility.h>
<span class="lineNum"> 36 </span> :
<span class="lineNum"> 37 </span> : // FIXME: sort this out so we avoid exposing Xapian::Query::Internal
<span class="lineNum"> 38 </span> : // - we need to at present so that the Xapian::Query's template ctors
<span class="lineNum"> 39 </span> : // compile.
<span class="lineNum"> 40 </span> : class LocalSubMatch;
<span class="lineNum"> 41 </span> : class MultiMatch;
<span class="lineNum"> 42 </span> : class QueryOptimiser;
<span class="lineNum"> 43 </span> : struct SortPosName;
<span class="lineNum"> 44 </span> :
<span class="lineNum"> 45 </span> : namespace Xapian {
<span class="lineNum"> 46 </span> :
<span class="lineNum"> 47 </span> : /** Class representing a query.
<span class="lineNum"> 48 </span> : *
<span class="lineNum"> 49 </span> : * Queries are represented as a tree of objects.
<span class="lineNum"> 50 </span> : */
<span class="lineNum"> 51 </span> : class XAPIAN_VISIBILITY_DEFAULT Query {
<span class="lineNum"> 52 </span> : public:
<span class="lineNum"> 53 </span> : /// Class holding details of the query
<span class="lineNum"> 54 </span> : class Internal;
<span class="lineNum"> 55 </span> : /// @private @internal Reference counted internals.
<span class="lineNum"> 56 </span> : Xapian::Internal::RefCntPtr<Internal> internal;
<span class="lineNum"> 57 </span> :
<span class="lineNum"> 58 </span> : /// Enum of possible query operations
<span class="lineNum"> 59 </span> : typedef enum {
<span class="lineNum"> 60 </span> : /// Return iff both subqueries are satisfied
<span class="lineNum"> 61 </span> : OP_AND,
<span class="lineNum"> 62 </span> :
<span class="lineNum"> 63 </span> : /// Return if either subquery is satisfied
<span class="lineNum"> 64 </span> : OP_OR,
<span class="lineNum"> 65 </span> :
<span class="lineNum"> 66 </span> : /// Return if left but not right satisfied
<span class="lineNum"> 67 </span> : OP_AND_NOT,
<span class="lineNum"> 68 </span> :
<span class="lineNum"> 69 </span> : /// Return if one query satisfied, but not both
<span class="lineNum"> 70 </span> : OP_XOR,
<span class="lineNum"> 71 </span> :
<span class="lineNum"> 72 </span> : /// Return iff left satisfied, but use weights from both
<span class="lineNum"> 73 </span> : OP_AND_MAYBE,
<span class="lineNum"> 74 </span> :
<span class="lineNum"> 75 </span> : /// As AND, but use only weights from left subquery
<span class="lineNum"> 76 </span> : OP_FILTER,
<span class="lineNum"> 77 </span> :
<span class="lineNum"> 78 </span> : /** Find occurrences of a list of terms with all the terms
<span class="lineNum"> 79 </span> : * occurring within a specified window of positions.
<span class="lineNum"> 80 </span> : * Each occurrence of a term must be at a different position,
<span class="lineNum"> 81 </span> : * but the order they appear in is irrelevant.
<span class="lineNum"> 82 </span> : *
<span class="lineNum"> 83 </span> : * The window parameter should be specified for this operation,
<span class="lineNum"> 84 </span> : * but will default to the number of terms in the list.
<span class="lineNum"> 85 </span> : */
<span class="lineNum"> 86 </span> : OP_NEAR,
<span class="lineNum"> 87 </span> :
<span class="lineNum"> 88 </span> : /** Find occurrences of a list of terms with all the terms
<span class="lineNum"> 89 </span> : * occurring within a specified window of positions, and all
<span class="lineNum"> 90 </span> : * the terms appearing in the order specified. Each occurrence
<span class="lineNum"> 91 </span> : * of a term must be at a different position.
<span class="lineNum"> 92 </span> : *
<span class="lineNum"> 93 </span> : * The window parameter should be specified for this operation,
<span class="lineNum"> 94 </span> : * but will default to the number of terms in the list.
<span class="lineNum"> 95 </span> : */
<span class="lineNum"> 96 </span> : OP_PHRASE,
<span class="lineNum"> 97 </span> :
<span class="lineNum"> 98 </span> : /** Filter by a range test on a document value. */
<span class="lineNum"> 99 </span> : OP_VALUE_RANGE,
<span class="lineNum"> 100 </span> :
<span class="lineNum"> 101 </span> : /** Scale the weight of a subquery by the specified factor.
<span class="lineNum"> 102 </span> : *
<span class="lineNum"> 103 </span> : * A factor of 0 means this subquery will contribute no weight to
<span class="lineNum"> 104 </span> : * the query - it will act as a purely boolean subquery.
<span class="lineNum"> 105 </span> : *
<span class="lineNum"> 106 </span> : * If the factor is negative, Xapian::InvalidArgumentError will
<span class="lineNum"> 107 </span> : * be thrown.
<span class="lineNum"> 108 </span> : */
<span class="lineNum"> 109 </span> : OP_SCALE_WEIGHT,
<span class="lineNum"> 110 </span> :
<span class="lineNum"> 111 </span> : /** Select an elite set from the subqueries, and perform
<span class="lineNum"> 112 </span> : * a query with these combined as an OR query.
<span class="lineNum"> 113 </span> : */
<span class="lineNum"> 114 </span> : OP_ELITE_SET,
<span class="lineNum"> 115 </span> :
<span class="lineNum"> 116 </span> : /** Filter by a greater-than-or-equal test on a document value. */
<span class="lineNum"> 117 </span> : OP_VALUE_GE,
<span class="lineNum"> 118 </span> :
<span class="lineNum"> 119 </span> : /** Filter by a less-than-or-equal test on a document value. */
<span class="lineNum"> 120 </span> : OP_VALUE_LE
<span class="lineNum"> 121 </span> : } op;
<span class="lineNum"> 122 </span> :
<span class="lineNum"> 123 </span> : /** Copy constructor. */
<span class="lineNum"> 124 </span> : Query(const Query & copyme);
<span class="lineNum"> 125 </span> :
<span class="lineNum"> 126 </span> : /** Assignment. */
<span class="lineNum"> 127 </span> : Query & operator=(const Query & copyme);
<span class="lineNum"> 128 </span> :
<span class="lineNum"> 129 </span> : /** Default constructor: makes an empty query which matches no
<span class="lineNum"> 130 </span> : * documents.
<span class="lineNum"> 131 </span> : *
<span class="lineNum"> 132 </span> : * Also useful for defining a Query object to be assigned to later.
<span class="lineNum"> 133 </span> : *
<span class="lineNum"> 134 </span> : * An exception will be thrown if an attempt is made to use an
<span class="lineNum"> 135 </span> : * undefined query when building up a composite query.
<span class="lineNum"> 136 </span> : */
<span class="lineNum"> 137 </span> : Query();
<span class="lineNum"> 138 </span> :
<span class="lineNum"> 139 </span> : /** Destructor. */
<span class="lineNum"> 140 </span> : ~Query();
<span class="lineNum"> 141 </span> :
<span class="lineNum"> 142 </span> : /** A query consisting of a single term. */
<span class="lineNum"> 143 </span> : Query(const std::string & tname_, Xapian::termcount wqf_ = 1,
<span class="lineNum"> 144 </span> : Xapian::termpos pos_ = 0);
<span class="lineNum"> 145 </span> :
<span class="lineNum"> 146 </span> : /** A query consisting of two subqueries, opp-ed together. */
<span class="lineNum"> 147 </span> : Query(Query::op op_, const Query & left, const Query & right);
<span class="lineNum"> 148 </span> :
<span class="lineNum"> 149 </span> : /** A query consisting of two termnames opp-ed together. */
<span class="lineNum"> 150 </span> : Query(Query::op op_,
<span class="lineNum"> 151 </span> : const std::string & left, const std::string & right);
<span class="lineNum"> 152 </span> :
<span class="lineNum"> 153 </span> : /** Combine a number of Xapian::Query-s with the specified operator.
<span class="lineNum"> 154 </span> : *
<span class="lineNum"> 155 </span> : * The Xapian::Query objects are specified with begin and end
<span class="lineNum"> 156 </span> : * iterators.
<span class="lineNum"> 157 </span> : *
<span class="lineNum"> 158 </span> : * AND, OR, NEAR and PHRASE can take any number of subqueries.
<span class="lineNum"> 159 </span> : * Other operators take exactly two subqueries.
<span class="lineNum"> 160 </span> : *
<span class="lineNum"> 161 </span> : * The iterators may be to Xapian::Query objects, pointers to
<span class="lineNum"> 162 </span> : * Xapian::Query objects, or termnames (std::string-s).
<span class="lineNum"> 163 </span> : *
<span class="lineNum"> 164 </span> : * For NEAR and PHRASE, a window size can be specified in parameter.
<span class="lineNum"> 165 </span> : *
<span class="lineNum"> 166 </span> : * For ELITE_SET, the elite set size can be specified in parameter.
<span class="lineNum"> 167 </span> : */
<span class="lineNum"> 168 </span> : template <class Iterator>
<span class="lineNum"> 169 </span> : Query(Query::op op_, Iterator qbegin, Iterator qend,
<span class="lineNum"> 170 </span> : Xapian::termcount parameter = 0);
<span class="lineNum"> 171 </span> :
<span class="lineNum"> 172 </span> : /** Apply the specified operator to a single Xapian::Query object.
<span class="lineNum"> 173 </span> : *
<span class="lineNum"> 174 </span> : * @deprecated This method is deprecated because it isn't useful,
<span class="lineNum"> 175 </span> : * since none of the current query operators can be usefully
<span class="lineNum"> 176 </span> : * applied to a single subquery with a parameter value.
<span class="lineNum"> 177 </span> : */
<span class="lineNum"> 178 </span> : XAPIAN_DEPRECATED(Query(Query::op op_, Xapian::Query q));
<span class="lineNum"> 179 </span> :
<span class="lineNum"> 180 </span> : /** Apply the specified operator to a single Xapian::Query object, with
<span class="lineNum"> 181 </span> : * a double parameter.
<span class="lineNum"> 182 </span> : */
<span class="lineNum"> 183 </span> : Query(Query::op op_, Xapian::Query q, double parameter);
<span class="lineNum"> 184 </span> :
<span class="lineNum"> 185 </span> : /** Construct a value range query on a document value.
<span class="lineNum"> 186 </span> : *
<span class="lineNum"> 187 </span> : * A value range query matches those documents which have a value
<span class="lineNum"> 188 </span> : * stored in the slot given by @a valno which is in the range
<span class="lineNum"> 189 </span> : * specified by @a begin and @a end (in lexicographical
<span class="lineNum"> 190 </span> : * order), including the endpoints.
<span class="lineNum"> 191 </span> : *
<span class="lineNum"> 192 </span> : * @param op_ The operator to use for the query. Currently, must
<span class="lineNum"> 193 </span> : * be OP_VALUE_RANGE.
<span class="lineNum"> 194 </span> : * @param valno The slot number to get the value from.
<span class="lineNum"> 195 </span> : * @param begin The start of the range.
<span class="lineNum"> 196 </span> : * @param end The end of the range.
<span class="lineNum"> 197 </span> : */
<span class="lineNum"> 198 </span> : Query(Query::op op_, Xapian::valueno valno,
<span class="lineNum"> 199 </span> : const std::string &begin, const std::string &end);
<span class="lineNum"> 200 </span> :
<span class="lineNum"> 201 </span> : /** Construct a value comparison query on a document value.
<span class="lineNum"> 202 </span> : *
<span class="lineNum"> 203 </span> : * This query matches those documents which have a value stored in the
<span class="lineNum"> 204 </span> : * slot given by @a valno which compares, as specified by the
<span class="lineNum"> 205 </span> : * operator, to @a value.
<span class="lineNum"> 206 </span> : *
<span class="lineNum"> 207 </span> : * @param op_ The operator to use for the query. Currently, must
<span class="lineNum"> 208 </span> : * be OP_VALUE_GE or OP_VALUE_LE.
<span class="lineNum"> 209 </span> : * @param valno The slot number to get the value from.
<span class="lineNum"> 210 </span> : * @param value The value to compare.
<span class="lineNum"> 211 </span> : */
<span class="lineNum"> 212 </span> : Query(Query::op op_, Xapian::valueno valno, const std::string &value);
<span class="lineNum"> 213 </span> :
<span class="lineNum"> 214 </span> : /** A query which matches all documents in the database. */
<span class="lineNum"> 215 </span> : static Xapian::Query MatchAll;
<span class="lineNum"> 216 </span> :
<span class="lineNum"> 217 </span> : /** A query which matches no documents. */
<span class="lineNum"> 218 </span> : static Xapian::Query MatchNothing;
<span class="lineNum"> 219 </span> :
<span class="lineNum"> 220 </span> : /** Get the length of the query, used by some ranking formulae.
<span class="lineNum"> 221 </span> : * This value is calculated automatically - if you want to override
<span class="lineNum"> 222 </span> : * it you can pass a different value to Enquire::set_query().
<span class="lineNum"> 223 </span> : */
<span class="lineNum"> 224 </span> : Xapian::termcount get_length() const;
<span class="lineNum"> 225 </span> :
<span class="lineNum"> 226 </span> : /** Return a Xapian::TermIterator returning all the terms in the query,
<span class="lineNum"> 227 </span> : * in order of termpos. If multiple terms have the same term
<span class="lineNum"> 228 </span> : * position, their order is unspecified. Duplicates (same term and
<span class="lineNum"> 229 </span> : * termpos) will be removed.
<span class="lineNum"> 230 </span> : */
<span class="lineNum"> 231 </span> : TermIterator get_terms_begin() const;
<span class="lineNum"> 232 </span> :
<span class="lineNum"> 233 </span> : /** Return a Xapian::TermIterator to the end of the list of terms in the
<span class="lineNum"> 234 </span> : * query.
<span class="lineNum"> 235 </span> : */
<span class="lineNum"> 236 </span> : TermIterator get_terms_end() const {
<span class="lineNum"> 237 </span> : return TermIterator(NULL);
<span class="lineNum"> 238 </span> : }
<span class="lineNum"> 239 </span> :
<span class="lineNum"> 240 </span> : /** Test if the query is empty (i.e. was constructed using
<span class="lineNum"> 241 </span> : * the default ctor or with an empty iterator ctor).
<span class="lineNum"> 242 </span> : */
<span class="lineNum"> 243 </span> : bool empty() const;
<span class="lineNum"> 244 </span> :
<span class="lineNum"> 245 </span> : /// Return a string describing this object.
<span class="lineNum"> 246 </span> : std::string get_description() const;
<span class="lineNum"> 247 </span> :
<span class="lineNum"> 248 </span> : private:
<span class="lineNum"> 249 </span> : void add_subquery(const Query & subq);
<span class="lineNum"> 250 </span> : void add_subquery(const Query * subq);
<span class="lineNum"> 251 </span> : void add_subquery(const std::string & tname);
<span class="lineNum"> 252 </span> : void start_construction(Query::op op_, Xapian::termcount parameter);
<span class="lineNum"> 253 </span> : void end_construction();
<span class="lineNum"> 254 </span> : void abort_construction();
<span class="lineNum"> 255 </span> : };
<span class="lineNum"> 256 </span> :
<span class="lineNum"> 257 </span> : template <class Iterator>
<span class="lineNum"> 258 </span><span class="lineCov"> 19 : Query::Query(Query::op op_, Iterator qbegin, Iterator qend, termcount parameter)</span>
<span class="lineNum"> 259 </span><span class="lineCov"> 19 : : internal(0)</span>
<span class="lineNum"> 260 </span> : {
<span class="lineNum"> 261 </span> : try {
<span class="lineNum"> 262 </span><span class="lineCov"> 19 : start_construction(op_, parameter);</span>
<span class="lineNum"> 263 </span> :
<span class="lineNum"> 264 </span> : /* Add all the elements */
<span class="lineNum"> 265 </span><span class="lineCov"> 61 : while (qbegin != qend) {</span>
<span class="lineNum"> 266 </span><span class="lineCov"> 23 : add_subquery(*qbegin);</span>
<span class="lineNum"> 267 </span><span class="lineCov"> 23 : ++qbegin;</span>
<span class="lineNum"> 268 </span> : }
<span class="lineNum"> 269 </span> :
<span class="lineNum"> 270 </span><span class="lineCov"> 19 : end_construction();</span>
<span class="lineNum"> 271 </span><span class="lineNoCov"> 0 : } catch (...) {</span>
<span class="lineNum"> 272 </span><span class="lineNoCov"> 0 : abort_construction();</span>
<span class="lineNum"> 273 </span><span class="lineNoCov"> 0 : throw;</span>
<span class="lineNum"> 274 </span> : }
<span class="lineNum"> 275 </span><span class="lineCov"> 19 : }</span>
<span class="lineNum"> 276 </span> :
<span class="lineNum"> 277 </span> : /// @internal Internal class, implementing most of Xapian::Query.
<span class="lineNum"> 278 </span> : class XAPIAN_VISIBILITY_DEFAULT Query::Internal : public Xapian::Internal::RefCntBase {
<span class="lineNum"> 279 </span> : friend class ::LocalSubMatch;
<span class="lineNum"> 280 </span> : friend class ::MultiMatch;
<span class="lineNum"> 281 </span> : friend class ::QueryOptimiser;
<span class="lineNum"> 282 </span> : friend struct ::SortPosName;
<span class="lineNum"> 283 </span> : friend class Query;
<span class="lineNum"> 284 </span> : public:
<span class="lineNum"> 285 </span> : static const int OP_LEAF = -1;
<span class="lineNum"> 286 </span> :
<span class="lineNum"> 287 </span> : /// The container type for storing pointers to subqueries
<span class="lineNum"> 288 </span> : typedef std::vector<Internal *> subquery_list;
<span class="lineNum"> 289 </span> :
<span class="lineNum"> 290 </span> : /// Type storing the operation
<span class="lineNum"> 291 </span> : typedef int op_t;
<span class="lineNum"> 292 </span> :
<span class="lineNum"> 293 </span> : private:
<span class="lineNum"> 294 </span> : /// Operation to be performed at this node
<span class="lineNum"> 295 </span> : Xapian::Query::Internal::op_t op;
<span class="lineNum"> 296 </span> :
<span class="lineNum"> 297 </span> : /// Sub queries on which to perform operation
<span class="lineNum"> 298 </span> : subquery_list subqs;
<span class="lineNum"> 299 </span> :
<span class="lineNum"> 300 </span> : /** For NEAR or PHRASE, how close terms must be to match: all terms
<span class="lineNum"> 301 </span> : * within the operation must occur in a window of this size.
<span class="lineNum"> 302 </span> : *
<span class="lineNum"> 303 </span> : * For ELITE_SET, the number of terms to select from those specified.
<span class="lineNum"> 304 </span> : *
<span class="lineNum"> 305 </span> : * For RANGE, the value number to apply the range test to.
<span class="lineNum"> 306 </span> : */
<span class="lineNum"> 307 </span> : Xapian::termcount parameter;
<span class="lineNum"> 308 </span> :
<span class="lineNum"> 309 </span> : /** Term that this node represents, or start of a range query.
<span class="lineNum"> 310 </span> : *
<span class="lineNum"> 311 </span> : * For a leaf node, this holds the term name. For an OP_VALUE_RANGE
<span class="lineNum"> 312 </span> : * query this holds the start of the range. For an OP_VALUE_GE or
<span class="lineNum"> 313 </span> : * OP_VALUE_LE query this holds the value to compare against.
<span class="lineNum"> 314 </span> : */
<span class="lineNum"> 315 </span> : std::string tname;
<span class="lineNum"> 316 </span> :
<span class="lineNum"> 317 </span> : /** Used to store the end of a range query. */
<span class="lineNum"> 318 </span> : std::string str_parameter;
<span class="lineNum"> 319 </span> :
<span class="lineNum"> 320 </span> : /// Position in query of this term - leaf node only
<span class="lineNum"> 321 </span> : Xapian::termpos term_pos;
<span class="lineNum"> 322 </span> :
<span class="lineNum"> 323 </span> : /// Within query frequency of this term - leaf node only
<span class="lineNum"> 324 </span> : Xapian::termcount wqf;
<span class="lineNum"> 325 </span> :
<span class="lineNum"> 326 </span> : /** swap the contents of this with another Xapian::Query::Internal,
<span class="lineNum"> 327 </span> : * in a way which is guaranteed not to throw. This is
<span class="lineNum"> 328 </span> : * used with the assignment operator to make it exception
<span class="lineNum"> 329 </span> : * safe.
<span class="lineNum"> 330 </span> : * It's important to adjust swap with any addition of
<span class="lineNum"> 331 </span> : * member variables!
<span class="lineNum"> 332 </span> : */
<span class="lineNum"> 333 </span> : void swap(Query::Internal &other);
<span class="lineNum"> 334 </span> :
<span class="lineNum"> 335 </span> : /// Copy another Xapian::Query::Internal into self.
<span class="lineNum"> 336 </span> : void initialise_from_copy(const Query::Internal & copyme);
<span class="lineNum"> 337 </span> :
<span class="lineNum"> 338 </span> : void accumulate_terms(
<span class="lineNum"> 339 </span> : std::vector<std::pair<std::string, Xapian::termpos> > &terms) const;
<span class="lineNum"> 340 </span> :
<span class="lineNum"> 341 </span> : /** Simplify the query.
<span class="lineNum"> 342 </span> : * For example, an AND query with only one subquery would become the
<span class="lineNum"> 343 </span> : * subquery itself.
<span class="lineNum"> 344 </span> : */
<span class="lineNum"> 345 </span> : Internal * simplify_query();
<span class="lineNum"> 346 </span> :
<span class="lineNum"> 347 </span> : /** Perform checks that query is valid. (eg, has correct number of
<span class="lineNum"> 348 </span> : * sub queries.) Throw an exception if not. This is initially called
<span class="lineNum"> 349 </span> : * on the query before any simplifications have been made, and after
<span class="lineNum"> 350 </span> : * simplications.
<span class="lineNum"> 351 </span> : */
<span class="lineNum"> 352 </span> : void validate_query() const;
<span class="lineNum"> 353 </span> :
<span class="lineNum"> 354 </span> : /** Simplify any matchnothing subqueries, either eliminating them,
<span class="lineNum"> 355 </span> : * or setting this query to matchnothing, depending on the query
<span class="lineNum"> 356 </span> : * operator. Returns true if simplification resulted in a
<span class="lineNum"> 357 </span> : * matchnothing query.
<span class="lineNum"> 358 </span> : */
<span class="lineNum"> 359 </span> : bool simplify_matchnothing();
<span class="lineNum"> 360 </span> :
<span class="lineNum"> 361 </span> : /** Get a string describing the given query type.
<span class="lineNum"> 362 </span> : */
<span class="lineNum"> 363 </span> : static std::string get_op_name(Xapian::Query::Internal::op_t op);
<span class="lineNum"> 364 </span> :
<span class="lineNum"> 365 </span> : /** Collapse the subqueries together if appropriate.
<span class="lineNum"> 366 </span> : */
<span class="lineNum"> 367 </span> : void collapse_subqs();
<span class="lineNum"> 368 </span> :
<span class="lineNum"> 369 </span> : /** Flatten a query structure, by changing, for example,
<span class="lineNum"> 370 </span> : * "A NEAR (B AND C)" to "(A NEAR B) AND (A NEAR C)"
<span class="lineNum"> 371 </span> : */
<span class="lineNum"> 372 </span> : void flatten_subqs();
<span class="lineNum"> 373 </span> :
<span class="lineNum"> 374 </span> : /** Implementation of serialisation; called recursively.
<span class="lineNum"> 375 </span> : */
<span class="lineNum"> 376 </span> : std::string serialise(Xapian::termpos & curpos) const;
<span class="lineNum"> 377 </span> :
<span class="lineNum"> 378 </span> : public:
<span class="lineNum"> 379 </span> : /** Copy constructor. */
<span class="lineNum"> 380 </span> : Internal(const Query::Internal & copyme);
<span class="lineNum"> 381 </span> :
<span class="lineNum"> 382 </span> : /** Assignment. */
<span class="lineNum"> 383 </span> : void operator=(const Query::Internal & copyme);
<span class="lineNum"> 384 </span> :
<span class="lineNum"> 385 </span> : /** A query consisting of a single term. */
<span class="lineNum"> 386 </span> : explicit Internal(const std::string & tname_, Xapian::termcount wqf_ = 1,
<span class="lineNum"> 387 </span> : Xapian::termpos term_pos_ = 0);
<span class="lineNum"> 388 </span> :
<span class="lineNum"> 389 </span> : /** Create internals given only the operator and a parameter. */
<span class="lineNum"> 390 </span> : Internal(op_t op_, Xapian::termcount parameter);
<span class="lineNum"> 391 </span> :
<span class="lineNum"> 392 </span> : /** Construct a range query on a document value. */
<span class="lineNum"> 393 </span> : Internal(op_t op_, Xapian::valueno valno,
<span class="lineNum"> 394 </span> : const std::string &begin, const std::string &end);
<span class="lineNum"> 395 </span> :
<span class="lineNum"> 396 </span> : /** Construct a value greater-than-or-equal query on a document value.
<span class="lineNum"> 397 </span> : */
<span class="lineNum"> 398 </span> : Internal(op_t op_, Xapian::valueno valno, const std::string &value);
<span class="lineNum"> 399 </span> :
<span class="lineNum"> 400 </span> : /** Destructor. */
<span class="lineNum"> 401 </span> : ~Internal();
<span class="lineNum"> 402 </span> :
<span class="lineNum"> 403 </span> : static Xapian::Query::Internal * unserialise(const std::string &s);
<span class="lineNum"> 404 </span> :
<span class="lineNum"> 405 </span> : /** Add a subquery.
<span class="lineNum"> 406 </span> : */
<span class="lineNum"> 407 </span> : void add_subquery(const Query::Internal * subq);
<span class="lineNum"> 408 </span> :
<span class="lineNum"> 409 </span> : void set_dbl_parameter(double dbl_parameter_);
<span class="lineNum"> 410 </span> :
<span class="lineNum"> 411 </span> : double get_dbl_parameter() const;
<span class="lineNum"> 412 </span> :
<span class="lineNum"> 413 </span> : /** Finish off the construction.
<span class="lineNum"> 414 </span> : */
<span class="lineNum"> 415 </span> : Query::Internal * end_construction();
<span class="lineNum"> 416 </span> :
<span class="lineNum"> 417 </span> : /** Return a string in an easily parsed form
<span class="lineNum"> 418 </span> : * which contains all the information in a query.
<span class="lineNum"> 419 </span> : */
<span class="lineNum"> 420 </span> : std::string serialise() const {
<span class="lineNum"> 421 </span> : Xapian::termpos curpos = 1;
<span class="lineNum"> 422 </span> : return serialise(curpos);
<span class="lineNum"> 423 </span> : }
<span class="lineNum"> 424 </span> :
<span class="lineNum"> 425 </span> : /// Return a string describing this object.
<span class="lineNum"> 426 </span> : std::string get_description() const;
<span class="lineNum"> 427 </span> :
<span class="lineNum"> 428 </span> : /** Get the numeric parameter used in this query.
<span class="lineNum"> 429 </span> : *
<span class="lineNum"> 430 </span> : * This is used by the QueryParser to get the value number for
<span class="lineNum"> 431 </span> : * VALUE_RANGE queries. It should be replaced by a public method on
<span class="lineNum"> 432 </span> : * the Query class at some point, but the API which should be used for
<span class="lineNum"> 433 </span> : * that is unclear, so this is a temporary workaround.
<span class="lineNum"> 434 </span> : */
<span class="lineNum"> 435 </span> : Xapian::termcount get_parameter() const { return parameter; }
<span class="lineNum"> 436 </span> :
<span class="lineNum"> 437 </span> : /** Get the length of the query, used by some ranking formulae.
<span class="lineNum"> 438 </span> : * This value is calculated automatically - if you want to override
<span class="lineNum"> 439 </span> : * it you can pass a different value to Enquire::set_query().
<span class="lineNum"> 440 </span> : */
<span class="lineNum"> 441 </span> : Xapian::termcount get_length() const;
<span class="lineNum"> 442 </span> :
<span class="lineNum"> 443 </span> : /** Return an iterator over all the terms in the query,
<span class="lineNum"> 444 </span> : * in order of termpos. If multiple terms have the same term
<span class="lineNum"> 445 </span> : * position, their order is unspecified. Duplicates (same term and
<span class="lineNum"> 446 </span> : * termpos) will be removed.
<span class="lineNum"> 447 </span> : */
<span class="lineNum"> 448 </span> : TermIterator get_terms() const;
<span class="lineNum"> 449 </span> : };
<span class="lineNum"> 450 </span> :
<span class="lineNum"> 451 </span> : }
<span class="lineNum"> 452 </span> :
<span class="lineNum"> 453 </span> : #endif /* XAPIAN_INCLUDED_QUERY_H */
</pre>
</td>
</tr>
</table>
<br>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr>
<tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr>
</table>
<br>
</body>
</html>
|
