/usr/share/gtk-doc/html/dee-1.0/DeeIndex.html is in libdee-doc 1.0.10-3.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Dee Reference Manual: DeeIndex</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Dee Reference Manual">
<link rel="up" href="ch03.html" title="Indexes">
<link rel="prev" href="DeeHashIndex.html" title="DeeHashIndex">
<link rel="next" href="dee-1.0-Model-Readers.html" title="Model Readers">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#DeeIndex.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#DeeIndex.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#DeeIndex.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="DeeHashIndex.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="dee-1.0-Model-Readers.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="DeeIndex"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="DeeIndex.top_of_page"></a>DeeIndex</span></h2>
<p>DeeIndex — An inverted index interface for smart access to a <span class="type">DeeModel</span></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="DeeIndex.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="DeeIndex.html#DeeIndexIterFunc" title="DeeIndexIterFunc ()">*DeeIndexIterFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="DeeIndex.html#dee-index-foreach" title="dee_index_foreach ()">dee_index_foreach</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="returnvalue">DeeAnalyzer</span></a> *
</td>
<td class="function_name">
<a class="link" href="DeeIndex.html#dee-index-get-analyzer" title="dee_index_get_analyzer ()">dee_index_get_analyzer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">DeeModel</span> *
</td>
<td class="function_name">
<a class="link" href="DeeIndex.html#dee-index-get-model" title="dee_index_get_model ()">dee_index_get_model</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="DeeIndex.html#dee-index-get-n-rows" title="dee_index_get_n_rows ()">dee_index_get_n_rows</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="DeeIndex.html#dee-index-get-n-rows-for-term" title="dee_index_get_n_rows_for_term ()">dee_index_get_n_rows_for_term</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="DeeIndex.html#dee-index-get-n-terms" title="dee_index_get_n_terms ()">dee_index_get_n_terms</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="returnvalue">DeeModelReader</span></a> *
</td>
<td class="function_name">
<a class="link" href="DeeIndex.html#dee-index-get-reader" title="dee_index_get_reader ()">dee_index_get_reader</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="DeeIndex.html#dee-index-get-supported-term-match-flags" title="dee_index_get_supported_term_match_flags ()">dee_index_get_supported_term_match_flags</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">DeeResultSet</span> *
</td>
<td class="function_name">
<a class="link" href="DeeIndex.html#dee-index-lookup" title="dee_index_lookup ()">dee_index_lookup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *
</td>
<td class="function_name">
<a class="link" href="DeeIndex.html#dee-index-lookup-one" title="dee_index_lookup_one ()">dee_index_lookup_one</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeIndex.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> *</td>
<td class="property_name"><a class="link" href="DeeIndex.html#DeeIndex--analyzer" title="The “analyzer” property">analyzer</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">DeeModel</span> *</td>
<td class="property_name"><a class="link" href="DeeIndex.html#DeeIndex--model" title="The “model” property">model</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">gpointer</span></td>
<td class="property_name"><a class="link" href="DeeIndex.html#DeeIndex--reader" title="The “reader” property">reader</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeIndex.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="DeeIndex.html#DeeIndex-struct" title="struct DeeIndex">DeeIndex</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="DeeIndex.html#DeeIndexClass" title="struct DeeIndexClass">DeeIndexClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="DeeIndex.html#DeeTermMatchFlag" title="enum DeeTermMatchFlag">DeeTermMatchFlag</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeIndex.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> DeeIndex
<span class="lineart">├──</span> <a class="link" href="DeeHashIndex.html" title="DeeHashIndex">DeeHashIndex</a>
<span class="lineart">╰──</span> <a class="link" href="DeeTreeIndex.html" title="DeeTreeIndex">DeeTreeIndex</a>
</pre>
</div>
<div class="refsect1">
<a name="DeeIndex.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <dee.h>
</pre>
</div>
<div class="refsect1">
<a name="DeeIndex.description"></a><h2>Description</h2>
<p><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> is an interface for doing key based access to a <span class="type">DeeModel</span>.
A key in the index is known as a <span class="emphasis"><em>term</em></span> and each term is
mapped to a set of matching <a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="type">DeeModelIter</span></a>s.</p>
<p>The terms are calculated by means of a <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> which extracts a set of
terms from a given row in the model adding these terms to a <a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a>.
There is a suite of analyzers shipped with Dee, which you can browse in the</p>
Analyzers section.
</div>
<div class="refsect1">
<a name="DeeIndex.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="DeeIndexIterFunc"></a><h3>DeeIndexIterFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
<span class="c_punctuation">(</span>*DeeIndexIterFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code><span class="type">DeeResultSet</span> *rows</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> userdata</code></em>);</pre>
<p>The signature of the function passed to <a class="link" href="DeeIndex.html#dee-index-foreach" title="dee_index_foreach ()"><code class="function">dee_index_foreach()</code></a>.</p>
<p>Be cautious if you plan on modifying the rows in the model via the
DeeModelIters you find. Your code may have to be reentrant since
the index may change in reaction to the changes in the model. It's not
impossible to do this in a non-broken manner, but it may likely require
you calling <code class="function">dee_model_freeze_signals()</code> and <code class="function">dee_model_thaw_signals()</code> at
strategic points.</p>
<div class="refsect3">
<a name="id-1.4.4.9.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>A key in the index being traversed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rows</p></td>
<td class="parameter_description"><p>A <span class="type">DeeResultSet</span>. Do not free or modify.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>userdata</p></td>
<td class="parameter_description"><p> The pointer passed to <a class="link" href="DeeIndex.html#dee-index-foreach" title="dee_index_foreach ()"><code class="function">dee_index_foreach()</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.2.7"></a><h4>Returns</h4>
<p> <code class="literal">FALSE</code> if iteration should stop, <code class="literal">TRUE</code> if it should continue</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-index-foreach"></a><h3>dee_index_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_index_foreach (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *start_term</code></em>,
<em class="parameter"><code><a class="link" href="DeeIndex.html#DeeIndexIterFunc" title="DeeIndexIterFunc ()"><span class="type">DeeIndexIterFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> userdata</code></em>);</pre>
<p>Iterate over an index optionally starting from some given term. Note that
unordered indexes (like <a class="link" href="DeeHashIndex.html" title="DeeHashIndex"><span class="type">DeeHashIndex</span></a>) has undefined behaviour with
this method.</p>
<div class="refsect3">
<a name="id-1.4.4.9.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The index to iterate over</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_term</p></td>
<td class="parameter_description"><p>The term to start from or <code class="literal">NULL</code> to iterate over all terms</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p> Called for each term in the index. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>userdata</p></td>
<td class="parameter_description"><p> Arbitrary data to pass back to <em class="parameter"><code>func</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-index-get-analyzer"></a><h3>dee_index_get_analyzer ()</h3>
<pre class="programlisting"><a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="returnvalue">DeeAnalyzer</span></a> *
dee_index_get_analyzer (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);</pre>
<p>Get the analyzer being used to analyze terms extracted with the
<a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> used by this index.</p>
<div class="refsect3">
<a name="id-1.4.4.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The index to get the analyzer for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.4.6"></a><h4>Returns</h4>
<p> The <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> used to analyze terms with. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-index-get-model"></a><h3>dee_index_get_model ()</h3>
<pre class="programlisting"><span class="returnvalue">DeeModel</span> *
dee_index_get_model (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);</pre>
<p>Get the model being indexed by this index</p>
<div class="refsect3">
<a name="id-1.4.4.9.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The index to get the model for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.5.6"></a><h4>Returns</h4>
<p> The <span class="type">DeeModel</span> being indexed by this index. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-index-get-n-rows"></a><h3>dee_index_get_n_rows ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dee_index_get_n_rows (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);</pre>
<p>Get the number of indexed rows. A row is only indexed if it has at least one
term associated with it. If the analyzer has returned 0 terms then the row
is omitted from the index.</p>
<div class="refsect3">
<a name="id-1.4.4.9.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The index to get the number of rows for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.6.6"></a><h4>Returns</h4>
<p> The number of rows in the index. Note that this may less than or
equal to <a class="link" href="dee-1.0-DeeModel.html#dee-model-get-n-rows" title="dee_model_get_n_rows ()"><code class="function">dee_model_get_n_rows()</code></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-index-get-n-rows-for-term"></a><h3>dee_index_get_n_rows_for_term ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dee_index_get_n_rows_for_term (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *term</code></em>);</pre>
<p>Get the number of rows that matches a given term</p>
<div class="refsect3">
<a name="id-1.4.4.9.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The index to inspect</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>term</p></td>
<td class="parameter_description"><p>The term to look for</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.7.6"></a><h4>Returns</h4>
<p> The number of rows in the index registered for the given term</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-index-get-n-terms"></a><h3>dee_index_get_n_terms ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dee_index_get_n_terms (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);</pre>
<p>Get the number of terms in the index</p>
<div class="refsect3">
<a name="id-1.4.4.9.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The index to get the number of terms for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.8.6"></a><h4>Returns</h4>
<p> The number of unique terms in the index</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-index-get-reader"></a><h3>dee_index_get_reader ()</h3>
<pre class="programlisting"><a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="returnvalue">DeeModelReader</span></a> *
dee_index_get_reader (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);</pre>
<p>Get the reader being used to extract terms from rows in the model</p>
<div class="refsect3">
<a name="id-1.4.4.9.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The index to get the reader for</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.9.6"></a><h4>Returns</h4>
<p> The <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> used to extract terms with. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-index-get-supported-term-match-flags"></a><h3>dee_index_get_supported_term_match_flags ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dee_index_get_supported_term_match_flags
(<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>);</pre>
<p>Get the <a class="link" href="DeeIndex.html#DeeTermMatchFlag" title="enum DeeTermMatchFlag"><span class="type">DeeTermMatchFlag</span></a> supported by this <a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> instance</p>
<div class="refsect3">
<a name="id-1.4.4.9.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The index to inspect</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.10.6"></a><h4>Returns</h4>
<p> A bit mask of the acceptedd <a class="link" href="DeeIndex.html#DeeTermMatchFlag" title="enum DeeTermMatchFlag"><span class="type">DeeTermMatchFlag</span></a>s</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-index-lookup"></a><h3>dee_index_lookup ()</h3>
<pre class="programlisting"><span class="returnvalue">DeeResultSet</span> *
dee_index_lookup (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *term</code></em>,
<em class="parameter"><code><a class="link" href="DeeIndex.html#DeeTermMatchFlag" title="enum DeeTermMatchFlag"><span class="type">DeeTermMatchFlag</span></a> flags</code></em>);</pre>
<div class="refsect3">
<a name="id-1.4.4.9.11.4"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The index to perform the lookup in</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>term</p></td>
<td class="parameter_description"><p>The term to look up on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>A bitmask of <a class="link" href="DeeIndex.html#DeeTermMatchFlag" title="enum DeeTermMatchFlag"><span class="type">DeeTermMatchFlag</span></a> to control how matching is
done</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.11.5"></a><h4>Returns</h4>
<p> A <span class="type">DeeResultSet</span>. Free with <code class="function">g_object_unref()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-index-lookup-one"></a><h3>dee_index_lookup_one ()</h3>
<pre class="programlisting"><a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="returnvalue">DeeModelIter</span></a> *
dee_index_lookup_one (<em class="parameter"><code><a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *term</code></em>);</pre>
<p>Convenience function in for cases where you have a priori guarantee that
a <a class="link" href="DeeIndex.html#dee-index-lookup" title="dee_index_lookup ()"><code class="function">dee_index_lookup()</code></a> call will return exactly 0 or 1 row. If the lookup
returns more than 1 row a warning will be printed on standard error and
<code class="literal">NULL</code> will be returned.</p>
<p>The typical use case for this function is if you need something akin to
a primary key in a relational database.</p>
<div class="refsect3">
<a name="id-1.4.4.9.12.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>The index to do the lookup in</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>term</p></td>
<td class="parameter_description"><p>The exact term to match</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.12.7"></a><h4>Returns</h4>
<p> A <a class="link" href="dee-1.0-DeeModel.html#DeeModelIter"><span class="type">DeeModelIter</span></a> pointing to the matching
row or <code class="literal">NULL</code> in case no rows matches <em class="parameter"><code>term</code></em>
. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="DeeIndex.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DeeIndex-struct"></a><h3>struct DeeIndex</h3>
<pre class="programlisting">struct DeeIndex;</pre>
<p>All fields in the DeeIndex structure are private and should never be
accessed directly</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeIndexClass"></a><h3>struct DeeIndexClass</h3>
<pre class="programlisting">struct DeeIndexClass {
GObjectClass parent_class;
DeeResultSet* (* lookup) (DeeIndex *self,
const gchar *term,
DeeTermMatchFlag flags);
void (* foreach) (DeeIndex *self,
const gchar *start_term,
DeeIndexIterFunc func,
gpointer userdata);
guint (* get_n_terms) (DeeIndex *self);
guint (* get_n_rows) (DeeIndex *self);
guint (* get_n_rows_for_term)(DeeIndex *self,
const gchar *term);
guint (*get_supported_term_match_flags) (DeeIndex *self);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeTermMatchFlag"></a><h3>enum DeeTermMatchFlag</h3>
<p>Flags passed to <a class="link" href="DeeIndex.html#dee-index-lookup" title="dee_index_lookup ()"><code class="function">dee_index_lookup()</code></a> to control how matching is done.
Note that it is not required that index backends support more than just
<a class="link" href="DeeIndex.html#DEE-TERM-MATCH-EXACT:CAPS"><span class="type">DEE_TERM_MATCH_EXACT</span></a>.</p>
<p>You can query for the supported flags with
<a class="link" href="DeeIndex.html#dee-index-get-supported-term-match-flags" title="dee_index_get_supported_term_match_flags ()"><code class="function">dee_index_get_supported_term_match_flags()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.10.4.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="DEE-TERM-MATCH-EXACT:CAPS"></a>DEE_TERM_MATCH_EXACT</p></td>
<td class="enum_member_description">
<p>Match terms byte for byte as specified in the
query string</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="DEE-TERM-MATCH-PREFIX:CAPS"></a>DEE_TERM_MATCH_PREFIX</p></td>
<td class="enum_member_description">
<p>Match if the indexed term begins with the byte string
being queried by. This is also sometimes known as
truncated- or wildcard queries</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="DeeIndex.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="DeeIndex--analyzer"></a><h3>The <code class="literal">“analyzer”</code> property</h3>
<pre class="programlisting"> “analyzer” <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> *</pre>
<p>Type: DeeAnalyzer
The <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> used to analyze terms extracted by the model reader</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeIndex--model"></a><h3>The <code class="literal">“model”</code> property</h3>
<pre class="programlisting"> “model” <span class="type">DeeModel</span> *</pre>
<p>The <span class="type">DeeModel</span> being indexed</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeIndex--reader"></a><h3>The <code class="literal">“reader”</code> property</h3>
<pre class="programlisting"> “reader” <span class="type">gpointer</span></pre>
<p>Type: DeeModelReader
The <a class="link" href="dee-1.0-Model-Readers.html#DeeModelReader" title="DeeModelReader"><span class="type">DeeModelReader</span></a> used to extract terms from rows in the model</p>
<p>Flags: Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|