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
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: Xapian::TermGenerator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</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_1TermGenerator.html">TermGenerator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1TermGenerator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::TermGenerator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Parses a piece of text and generate terms.
<a href="classXapian_1_1TermGenerator.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:af958165211e730a6910d6986ac55a825"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classXapian_1_1TermGenerator.html#af958165211e730a6910d6986ac55a825a652e030497621117c43e21e6c23035d8">FLAG_SPELLING</a> = 128,
<a class="el" href="classXapian_1_1TermGenerator.html#af958165211e730a6910d6986ac55a825a0b31ee76f4e202359c590645280c7027">FLAG_CJK_NGRAM</a> = 2048
}<tr class="memdesc:af958165211e730a6910d6986ac55a825"><td class="mdescLeft"> </td><td class="mdescRight">Flags to OR together and pass to <a class="el" href="classXapian_1_1TermGenerator.html#aa0d1f0ee309227852654e589ef441517" title="Set flags. ">TermGenerator::set_flags()</a>. <a href="classXapian_1_1TermGenerator.html#af958165211e730a6910d6986ac55a825">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:af958165211e730a6910d6986ac55a825"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a601e0430b9c2c91831a76f8f40d50ce1"><td class="memItemLeft" align="right" valign="top"><a id="a601e0430b9c2c91831a76f8f40d50ce1"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a601e0430b9c2c91831a76f8f40d50ce1">stem_strategy</a> { <b>STEM_NONE</b>,
<b>STEM_SOME</b>,
<b>STEM_ALL</b>,
<b>STEM_ALL_Z</b>
}<tr class="memdesc:a601e0430b9c2c91831a76f8f40d50ce1"><td class="mdescLeft"> </td><td class="mdescRight">Stemming strategies, for use with <a class="el" href="classXapian_1_1TermGenerator.html#a5046d3579a0eb7173ab615cbe5e99ee8" title="Set the stemming strategy. ">set_stemming_strategy()</a>. <br /></td></tr>
</td></tr>
<tr class="separator:a601e0430b9c2c91831a76f8f40d50ce1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6a0d2940ec91229d684fb104e0da3eb"><td class="memItemLeft" align="right" valign="top"><a id="ac6a0d2940ec91229d684fb104e0da3eb"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#ac6a0d2940ec91229d684fb104e0da3eb">stop_strategy</a> { <b>STOP_NONE</b>,
<b>STOP_ALL</b>,
<b>STOP_STEMMED</b>
}<tr class="memdesc:ac6a0d2940ec91229d684fb104e0da3eb"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Stopper.html" title="Base class for stop-word decision functor. ">Stopper</a> strategies, for use with <a class="el" href="classXapian_1_1TermGenerator.html#aec58751aec187d8b2647579c150667c2" title="Set the stopper strategy. ">set_stopper_strategy()</a>. <br /></td></tr>
</td></tr>
<tr class="separator:ac6a0d2940ec91229d684fb104e0da3eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab74c54d35c2e3b17e59d4e65f160dbc2"><td class="memItemLeft" align="right" valign="top"><a id="ab74c54d35c2e3b17e59d4e65f160dbc2"></a>
typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#ab74c54d35c2e3b17e59d4e65f160dbc2">flags</a></td></tr>
<tr class="memdesc:ab74c54d35c2e3b17e59d4e65f160dbc2"><td class="mdescLeft"> </td><td class="mdescRight">For backward compatibility with <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> 1.2. <br /></td></tr>
<tr class="separator:ab74c54d35c2e3b17e59d4e65f160dbc2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a331dd5585658fc56baf91de4617f3ffd"><td class="memItemLeft" align="right" valign="top"><a id="a331dd5585658fc56baf91de4617f3ffd"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a331dd5585658fc56baf91de4617f3ffd">TermGenerator</a> (const <a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a> &o)</td></tr>
<tr class="memdesc:a331dd5585658fc56baf91de4617f3ffd"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:a331dd5585658fc56baf91de4617f3ffd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a532945e0a6f0bbc98119ea5298d254de"><td class="memItemLeft" align="right" valign="top"><a id="a532945e0a6f0bbc98119ea5298d254de"></a>
<a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a532945e0a6f0bbc98119ea5298d254de">operator=</a> (const <a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a> &o)</td></tr>
<tr class="memdesc:a532945e0a6f0bbc98119ea5298d254de"><td class="mdescLeft"> </td><td class="mdescRight">Assignment. <br /></td></tr>
<tr class="separator:a532945e0a6f0bbc98119ea5298d254de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfcaae65a459d31b5497154847213bbc"><td class="memItemLeft" align="right" valign="top"><a id="abfcaae65a459d31b5497154847213bbc"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#abfcaae65a459d31b5497154847213bbc">TermGenerator</a> ()</td></tr>
<tr class="memdesc:abfcaae65a459d31b5497154847213bbc"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:abfcaae65a459d31b5497154847213bbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8f5c0681963870e37a5b0f66be32819"><td class="memItemLeft" align="right" valign="top"><a id="ac8f5c0681963870e37a5b0f66be32819"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#ac8f5c0681963870e37a5b0f66be32819">~TermGenerator</a> ()</td></tr>
<tr class="memdesc:ac8f5c0681963870e37a5b0f66be32819"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ac8f5c0681963870e37a5b0f66be32819"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8813a97565e16d547183337e7647b711"><td class="memItemLeft" align="right" valign="top"><a id="a8813a97565e16d547183337e7647b711"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a8813a97565e16d547183337e7647b711">set_stemmer</a> (const <a class="el" href="classXapian_1_1Stem.html">Xapian::Stem</a> &stemmer)</td></tr>
<tr class="memdesc:a8813a97565e16d547183337e7647b711"><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Xapian::Stem</a> object to be used for generating stemmed terms. <br /></td></tr>
<tr class="separator:a8813a97565e16d547183337e7647b711"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8cef8e7b696129a0fc311e47baaf2120"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a8cef8e7b696129a0fc311e47baaf2120">set_stopper</a> (const <a class="el" href="classXapian_1_1Stopper.html">Xapian::Stopper</a> *stop=NULL)</td></tr>
<tr class="memdesc:a8cef8e7b696129a0fc311e47baaf2120"><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classXapian_1_1Stopper.html" title="Base class for stop-word decision functor. ">Xapian::Stopper</a> object to be used for identifying stopwords. <a href="#a8cef8e7b696129a0fc311e47baaf2120">More...</a><br /></td></tr>
<tr class="separator:a8cef8e7b696129a0fc311e47baaf2120"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af478b20d2a088697368dc2c1f1045675"><td class="memItemLeft" align="right" valign="top"><a id="af478b20d2a088697368dc2c1f1045675"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#af478b20d2a088697368dc2c1f1045675">set_document</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &doc)</td></tr>
<tr class="memdesc:af478b20d2a088697368dc2c1f1045675"><td class="mdescLeft"> </td><td class="mdescRight">Set the current document. <br /></td></tr>
<tr class="separator:af478b20d2a088697368dc2c1f1045675"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf6b9a9b715a73e3fc4f0710178dba96"><td class="memItemLeft" align="right" valign="top"><a id="acf6b9a9b715a73e3fc4f0710178dba96"></a>
const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#acf6b9a9b715a73e3fc4f0710178dba96">get_document</a> () const</td></tr>
<tr class="memdesc:acf6b9a9b715a73e3fc4f0710178dba96"><td class="mdescLeft"> </td><td class="mdescRight">Get the current document. <br /></td></tr>
<tr class="separator:acf6b9a9b715a73e3fc4f0710178dba96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56edabc2673241bcd87c3bd6b65e9c6d"><td class="memItemLeft" align="right" valign="top"><a id="a56edabc2673241bcd87c3bd6b65e9c6d"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a56edabc2673241bcd87c3bd6b65e9c6d">set_database</a> (const <a class="el" href="classXapian_1_1WritableDatabase.html">Xapian::WritableDatabase</a> &db)</td></tr>
<tr class="memdesc:a56edabc2673241bcd87c3bd6b65e9c6d"><td class="mdescLeft"> </td><td class="mdescRight">Set the database to index spelling data to. <br /></td></tr>
<tr class="separator:a56edabc2673241bcd87c3bd6b65e9c6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0d1f0ee309227852654e589ef441517"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1TermGenerator.html#ab74c54d35c2e3b17e59d4e65f160dbc2">flags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#aa0d1f0ee309227852654e589ef441517">set_flags</a> (<a class="el" href="classXapian_1_1TermGenerator.html#ab74c54d35c2e3b17e59d4e65f160dbc2">flags</a> toggle, <a class="el" href="classXapian_1_1TermGenerator.html#ab74c54d35c2e3b17e59d4e65f160dbc2">flags</a> mask=<a class="el" href="classXapian_1_1TermGenerator.html#ab74c54d35c2e3b17e59d4e65f160dbc2">flags</a>(0))</td></tr>
<tr class="memdesc:aa0d1f0ee309227852654e589ef441517"><td class="mdescLeft"> </td><td class="mdescRight">Set flags. <a href="#aa0d1f0ee309227852654e589ef441517">More...</a><br /></td></tr>
<tr class="separator:aa0d1f0ee309227852654e589ef441517"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5046d3579a0eb7173ab615cbe5e99ee8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a5046d3579a0eb7173ab615cbe5e99ee8">set_stemming_strategy</a> (<a class="el" href="classXapian_1_1TermGenerator.html#a601e0430b9c2c91831a76f8f40d50ce1">stem_strategy</a> strategy)</td></tr>
<tr class="memdesc:a5046d3579a0eb7173ab615cbe5e99ee8"><td class="mdescLeft"> </td><td class="mdescRight">Set the stemming strategy. <a href="#a5046d3579a0eb7173ab615cbe5e99ee8">More...</a><br /></td></tr>
<tr class="separator:a5046d3579a0eb7173ab615cbe5e99ee8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec58751aec187d8b2647579c150667c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#aec58751aec187d8b2647579c150667c2">set_stopper_strategy</a> (<a class="el" href="classXapian_1_1TermGenerator.html#ac6a0d2940ec91229d684fb104e0da3eb">stop_strategy</a> strategy)</td></tr>
<tr class="memdesc:aec58751aec187d8b2647579c150667c2"><td class="mdescLeft"> </td><td class="mdescRight">Set the stopper strategy. <a href="#aec58751aec187d8b2647579c150667c2">More...</a><br /></td></tr>
<tr class="separator:aec58751aec187d8b2647579c150667c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abda20f70114926ca259f0386ef55ca3b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#abda20f70114926ca259f0386ef55ca3b">set_max_word_length</a> (unsigned max_word_length)</td></tr>
<tr class="memdesc:abda20f70114926ca259f0386ef55ca3b"><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum length word to index. <a href="#abda20f70114926ca259f0386ef55ca3b">More...</a><br /></td></tr>
<tr class="separator:abda20f70114926ca259f0386ef55ca3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6916b0233aa4c326711667d2195db4d7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a6916b0233aa4c326711667d2195db4d7">index_text</a> (const <a class="el" href="classXapian_1_1Utf8Iterator.html">Xapian::Utf8Iterator</a> &itor, <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> wdf_inc=1, const std::string &prefix=std::string())</td></tr>
<tr class="memdesc:a6916b0233aa4c326711667d2195db4d7"><td class="mdescLeft"> </td><td class="mdescRight">Index some text. <a href="#a6916b0233aa4c326711667d2195db4d7">More...</a><br /></td></tr>
<tr class="separator:a6916b0233aa4c326711667d2195db4d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d98ef5625fe146e56b790c9c31c05f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a5d98ef5625fe146e56b790c9c31c05f4">index_text</a> (const std::string &text, <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> wdf_inc=1, const std::string &prefix=std::string())</td></tr>
<tr class="memdesc:a5d98ef5625fe146e56b790c9c31c05f4"><td class="mdescLeft"> </td><td class="mdescRight">Index some text in a std::string. <a href="#a5d98ef5625fe146e56b790c9c31c05f4">More...</a><br /></td></tr>
<tr class="separator:a5d98ef5625fe146e56b790c9c31c05f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa34cc9a0646793c4f5b9b56b2ec3c9a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#aa34cc9a0646793c4f5b9b56b2ec3c9a6">index_text_without_positions</a> (const <a class="el" href="classXapian_1_1Utf8Iterator.html">Xapian::Utf8Iterator</a> &itor, <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> wdf_inc=1, const std::string &prefix=std::string())</td></tr>
<tr class="memdesc:aa34cc9a0646793c4f5b9b56b2ec3c9a6"><td class="mdescLeft"> </td><td class="mdescRight">Index some text without positional information. <a href="#aa34cc9a0646793c4f5b9b56b2ec3c9a6">More...</a><br /></td></tr>
<tr class="separator:aa34cc9a0646793c4f5b9b56b2ec3c9a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9190f956783d94c9b699a2590aaaea43"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a9190f956783d94c9b699a2590aaaea43">index_text_without_positions</a> (const std::string &text, <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> wdf_inc=1, const std::string &prefix=std::string())</td></tr>
<tr class="memdesc:a9190f956783d94c9b699a2590aaaea43"><td class="mdescLeft"> </td><td class="mdescRight">Index some text in a std::string without positional information. <a href="#a9190f956783d94c9b699a2590aaaea43">More...</a><br /></td></tr>
<tr class="separator:a9190f956783d94c9b699a2590aaaea43"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79bd3a43ad8c9d1b711ec61ae9107e5f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a79bd3a43ad8c9d1b711ec61ae9107e5f">increase_termpos</a> (<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> delta=100)</td></tr>
<tr class="memdesc:a79bd3a43ad8c9d1b711ec61ae9107e5f"><td class="mdescLeft"> </td><td class="mdescRight">Increase the term position used by index_text. <a href="#a79bd3a43ad8c9d1b711ec61ae9107e5f">More...</a><br /></td></tr>
<tr class="separator:a79bd3a43ad8c9d1b711ec61ae9107e5f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bc963f83b30bf9211ddf3711f1c3248"><td class="memItemLeft" align="right" valign="top"><a id="a3bc963f83b30bf9211ddf3711f1c3248"></a>
<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a3bc963f83b30bf9211ddf3711f1c3248">get_termpos</a> () const</td></tr>
<tr class="memdesc:a3bc963f83b30bf9211ddf3711f1c3248"><td class="mdescLeft"> </td><td class="mdescRight">Get the current term position. <br /></td></tr>
<tr class="separator:a3bc963f83b30bf9211ddf3711f1c3248"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30b644e5568a225c7da9805774a4ebb4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a30b644e5568a225c7da9805774a4ebb4">set_termpos</a> (<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> <a class="el" href="namespaceXapian.html#ae5a16f073d0c8ed54085a9de07248d45">termpos</a>)</td></tr>
<tr class="memdesc:a30b644e5568a225c7da9805774a4ebb4"><td class="mdescLeft"> </td><td class="mdescRight">Set the current term position. <a href="#a30b644e5568a225c7da9805774a4ebb4">More...</a><br /></td></tr>
<tr class="separator:a30b644e5568a225c7da9805774a4ebb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a738b7fa0b6365c035e64c3d121b884ee"><td class="memItemLeft" align="right" valign="top"><a id="a738b7fa0b6365c035e64c3d121b884ee"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a738b7fa0b6365c035e64c3d121b884ee">get_description</a> () const</td></tr>
<tr class="memdesc:a738b7fa0b6365c035e64c3d121b884ee"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:a738b7fa0b6365c035e64c3d121b884ee"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parses a piece of text and generate terms. </p>
<p>This module takes a piece of text and parses it to produce words which are then used to generate suitable terms for indexing. The terms generated are suitable for use with <a class="el" href="classXapian_1_1Query.html" title="Class representing a query. ">Query</a> objects produced by the <a class="el" href="classXapian_1_1QueryParser.html" title="Build a Xapian::Query object from a user query string. ">QueryParser</a> class. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="af958165211e730a6910d6986ac55a825"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af958165211e730a6910d6986ac55a825">◆ </a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags to OR together and pass to <a class="el" href="classXapian_1_1TermGenerator.html#aa0d1f0ee309227852654e589ef441517" title="Set flags. ">TermGenerator::set_flags()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af958165211e730a6910d6986ac55a825a652e030497621117c43e21e6c23035d8"></a>FLAG_SPELLING </td><td class="fielddoc"><p>Index data required for spelling correction. </p>
</td></tr>
<tr><td class="fieldname"><a id="af958165211e730a6910d6986ac55a825a0b31ee76f4e202359c590645280c7027"></a>FLAG_CJK_NGRAM </td><td class="fielddoc"><p>Enable generation of n-grams from CJK text. </p>
<p>With this enabled, spans of CJK characters are split into unigrams and bigrams, with the unigrams carrying positional information. Non-CJK characters are split into words as normal.</p>
<p>The corresponding option needs to be passed to <a class="el" href="classXapian_1_1QueryParser.html" title="Build a Xapian::Query object from a user query string. ">QueryParser</a>.</p>
<p>Flag added in <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> 1.3.4 and 1.2.22, but this mode can be enabled in 1.2.8 and later by setting environment variable XAPIAN_CJK_NGRAM. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a79bd3a43ad8c9d1b711ec61ae9107e5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79bd3a43ad8c9d1b711ec61ae9107e5f">◆ </a></span>increase_termpos()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::increase_termpos </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>delta</em> = <code>100</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Increase the term position used by index_text. </p>
<p>This can be used between indexing text from different fields or other places to prevent phrase searches from spanning between them (e.g. between the title and body text, or between two chapters in a book).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delta</td><td>Amount to increase the term position by (default: 100). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6916b0233aa4c326711667d2195db4d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6916b0233aa4c326711667d2195db4d7">◆ </a></span>index_text() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::index_text </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Utf8Iterator.html">Xapian::Utf8Iterator</a> & </td>
<td class="paramname"><em>itor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>wdf_inc</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>prefix</em> = <code>std::string()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Index some text. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">itor</td><td><a class="el" href="classXapian_1_1Utf8Iterator.html" title="An iterator which returns Unicode character values from a UTF-8 encoded string. ">Utf8Iterator</a> pointing to the text to index. </td></tr>
<tr><td class="paramname">wdf_inc</td><td>The wdf increment (default 1). </td></tr>
<tr><td class="paramname">prefix</td><td>The term prefix to use (default is no prefix). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5d98ef5625fe146e56b790c9c31c05f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d98ef5625fe146e56b790c9c31c05f4">◆ </a></span>index_text() <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">void Xapian::TermGenerator::index_text </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>wdf_inc</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>prefix</em> = <code>std::string()</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>Index some text in a std::string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>The text to index. </td></tr>
<tr><td class="paramname">wdf_inc</td><td>The wdf increment (default 1). </td></tr>
<tr><td class="paramname">prefix</td><td>The term prefix to use (default is no prefix). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa34cc9a0646793c4f5b9b56b2ec3c9a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa34cc9a0646793c4f5b9b56b2ec3c9a6">◆ </a></span>index_text_without_positions() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::index_text_without_positions </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Utf8Iterator.html">Xapian::Utf8Iterator</a> & </td>
<td class="paramname"><em>itor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>wdf_inc</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>prefix</em> = <code>std::string()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Index some text without positional information. </p>
<p>Just like index_text, but no positional information is generated. This means that the database will be significantly smaller, but that phrase searching and NEAR won't be supported.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">itor</td><td><a class="el" href="classXapian_1_1Utf8Iterator.html" title="An iterator which returns Unicode character values from a UTF-8 encoded string. ">Utf8Iterator</a> pointing to the text to index. </td></tr>
<tr><td class="paramname">wdf_inc</td><td>The wdf increment (default 1). </td></tr>
<tr><td class="paramname">prefix</td><td>The term prefix to use (default is no prefix). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9190f956783d94c9b699a2590aaaea43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9190f956783d94c9b699a2590aaaea43">◆ </a></span>index_text_without_positions() <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">void Xapian::TermGenerator::index_text_without_positions </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>wdf_inc</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>prefix</em> = <code>std::string()</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>Index some text in a std::string without positional information. </p>
<p>Just like index_text, but no positional information is generated. This means that the database will be significantly smaller, but that phrase searching and NEAR won't be supported.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>The text to index. </td></tr>
<tr><td class="paramname">wdf_inc</td><td>The wdf increment (default 1). </td></tr>
<tr><td class="paramname">prefix</td><td>The term prefix to use (default is no prefix). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa0d1f0ee309227852654e589ef441517"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0d1f0ee309227852654e589ef441517">◆ </a></span>set_flags()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermGenerator.html#ab74c54d35c2e3b17e59d4e65f160dbc2">flags</a> Xapian::TermGenerator::set_flags </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1TermGenerator.html#ab74c54d35c2e3b17e59d4e65f160dbc2">flags</a> </td>
<td class="paramname"><em>toggle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXapian_1_1TermGenerator.html#ab74c54d35c2e3b17e59d4e65f160dbc2">flags</a> </td>
<td class="paramname"><em>mask</em> = <code><a class="el" href="classXapian_1_1TermGenerator.html#ab74c54d35c2e3b17e59d4e65f160dbc2">flags</a>(0)</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set flags. </p>
<p>The new value of flags is: (flags & mask) ^ toggle</p>
<p>To just set the flags, pass the new flags in toggle and the default value for mask.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">toggle</td><td>Flags to XOR. </td></tr>
<tr><td class="paramname">mask</td><td>Flags to AND with first.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The old flags setting. </dd></dl>
</div>
</div>
<a id="abda20f70114926ca259f0386ef55ca3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abda20f70114926ca259f0386ef55ca3b">◆ </a></span>set_max_word_length()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::set_max_word_length </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>max_word_length</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the maximum length word to index. </p>
<p>The limit is on the length of a word prior to stemming and prior to adding any term prefix.</p>
<p>The backends mostly impose a limit on the length of terms (often of about 240 bytes), but it's generally useful to have a lower limit to help prevent the index being bloated by useless junk terms from trying to indexing things like binary data, uuencoded data, ASCII art, etc.</p>
<p>This method was new in <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> 1.3.1.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">max_word_length</td><td>The maximum length word to index, in bytes in UTF-8 representation. Default is 64. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5046d3579a0eb7173ab615cbe5e99ee8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5046d3579a0eb7173ab615cbe5e99ee8">◆ </a></span>set_stemming_strategy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::set_stemming_strategy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1TermGenerator.html#a601e0430b9c2c91831a76f8f40d50ce1">stem_strategy</a> </td>
<td class="paramname"><em>strategy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the stemming strategy. </p>
<p>This method controls how the stemming algorithm is applied. It was new in <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> 1.3.1.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">strategy</td><td>The strategy to use - possible values are:<ul>
<li>STEM_NONE: Don't perform any stemming - only unstemmed terms are generated.</li>
<li>STEM_SOME: Generate both stemmed (with a "Z" prefix) and unstemmed terms. This is the default strategy.</li>
<li>STEM_ALL: Generate only stemmed terms (but without a "Z" prefix).</li>
<li>STEM_ALL_Z: Generate only stemmed terms (with a "Z" prefix). </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8cef8e7b696129a0fc311e47baaf2120"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cef8e7b696129a0fc311e47baaf2120">◆ </a></span>set_stopper()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::set_stopper </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Stopper.html">Xapian::Stopper</a> * </td>
<td class="paramname"><em>stop</em> = <code>NULL</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the <a class="el" href="classXapian_1_1Stopper.html" title="Base class for stop-word decision functor. ">Xapian::Stopper</a> object to be used for identifying stopwords. </p>
<p>Stemmed forms of stopwords aren't indexed, but unstemmed forms still are so that searches for phrases including stop words still work.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stop</td><td>The <a class="el" href="classXapian_1_1Stopper.html" title="Base class for stop-word decision functor. ">Stopper</a> object to set (default NULL, which means no stopwords). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aec58751aec187d8b2647579c150667c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec58751aec187d8b2647579c150667c2">◆ </a></span>set_stopper_strategy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::set_stopper_strategy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1TermGenerator.html#ac6a0d2940ec91229d684fb104e0da3eb">stop_strategy</a> </td>
<td class="paramname"><em>strategy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the stopper strategy. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">strategy</td><td>The strategy to use - possible values are:<ul>
<li>STOP_NONE: Disable stopper for both the stemmed and unstemmed form of the word (Don't use the stopper).</li>
<li>STOP_ALL: Enable stopper for both forms of the word.</li>
<li>STOP_STEMMED: Enable stopper for the stemmed form of the word. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a30b644e5568a225c7da9805774a4ebb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30b644e5568a225c7da9805774a4ebb4">◆ </a></span>set_termpos()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::set_termpos </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>termpos</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the current term position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">termpos</td><td>The new term position to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="termgenerator_8h.html">termgenerator.h</a></li>
</ul>
</div><!-- contents -->
<hr>
<address><small>
Documentation for Xapian (version 1.4.3).<br>
Generated on Wed Jan 25 2017 by
<a href="http://www.doxygen.org/">Doxygen 1.8.13</a>.
</small></address>
</body>
</html>
|
