<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: 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.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a></div>
<h1>Xapian::TermGenerator Class Reference</h1><!-- doxytag: class="Xapian::TermGenerator" -->Parses a piece of text and generate terms.
<a href="#_details">More...</a>
<p>
<a href="classXapian_1_1TermGenerator-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053">flags</a> { <a class="el" href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053a5d780146641afe79cf0d02586a569bd">FLAG_SPELLING</a> = 128
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flags to OR together and pass to <a class="el" href="classXapian_1_1TermGenerator.html#37e53a10371973c306004af9ffc1c971" title="Set flags.">TermGenerator::set_flags()</a>. <a href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#e5ee7c7bda5a0eeac559a2c7cf89012d">TermGenerator</a> (const <a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a> &o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#e5ee7c7bda5a0eeac559a2c7cf89012d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#1b660c4e818080543dc934b5c282f445">operator=</a> (const <a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a> &o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment. <a href="#1b660c4e818080543dc934b5c282f445"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#45687397c5e42377b7e421426e76e03f">TermGenerator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#45687397c5e42377b7e421426e76e03f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#5c680d9f115a755a2c40c2855b98ce04">~TermGenerator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#5c680d9f115a755a2c40c2855b98ce04"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#f7d43aef10aa6b26ef853a0ae2695f83">set_stemmer</a> (const <a class="el" href="classXapian_1_1Stem.html">Xapian::Stem</a> &stemmer)</td></tr>
<tr><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. <a href="#f7d43aef10aa6b26ef853a0ae2695f83"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#429fd0baaee382c4f30d44de253c535e">set_stopper</a> (const <a class="el" href="classXapian_1_1Stopper.html">Xapian::Stopper</a> *stop=NULL)</td></tr>
<tr><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="#429fd0baaee382c4f30d44de253c535e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#4f37bc778dfe7e1b0fdbed3a63360f4f">set_document</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &doc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current document. <a href="#4f37bc778dfe7e1b0fdbed3a63360f4f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">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#98a15106b882b435a4e4e1409fb27200">get_document</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current document. <a href="#98a15106b882b435a4e4e1409fb27200"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#7e5241b4d926e9d5cb453563426b0b12">set_database</a> (const <a class="el" href="classXapian_1_1WritableDatabase.html">Xapian::WritableDatabase</a> &db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the database to index spelling data to. <a href="#7e5241b4d926e9d5cb453563426b0b12"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053">flags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#37e53a10371973c306004af9ffc1c971">set_flags</a> (<a class="el" href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053">flags</a> toggle, <a class="el" href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053">flags</a> mask=<a class="el" href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053">flags</a>(0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set flags. <a href="#37e53a10371973c306004af9ffc1c971"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#4417b6d1e3c1bfcf06148945e2301a26">index_text</a> (const <a class="el" href="classXapian_1_1Utf8Iterator.html">Xapian::Utf8Iterator</a> &itor, <a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">weight</a>=1, const std::string &prefix="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index some text. <a href="#4417b6d1e3c1bfcf06148945e2301a26"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#b358784fa685139e8bdd71d37f39573e">index_text</a> (const std::string &text, <a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">weight</a>=1, const std::string &prefix="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index some text in a std::string. <a href="#b358784fa685139e8bdd71d37f39573e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#3f34e96855bd8288564c91ff355a1978">index_text_without_positions</a> (const <a class="el" href="classXapian_1_1Utf8Iterator.html">Xapian::Utf8Iterator</a> &itor, <a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">weight</a>=1, const std::string &prefix="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index some text without positional information. <a href="#3f34e96855bd8288564c91ff355a1978"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#62240a160aedf37baf67144b9681dcd6">index_text_without_positions</a> (const std::string &text, <a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> <a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">weight</a>=1, const std::string &prefix="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index some text in a std::string without positional information. <a href="#62240a160aedf37baf67144b9681dcd6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#d416c0d61264440d8ee2b42f46118d9f">increase_termpos</a> (<a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> delta=100)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increase the termpos used by index_text by <em>delta</em>. <a href="#d416c0d61264440d8ee2b42f46118d9f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#6735053643dd5aca94a6f7da4272c69b">get_termpos</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current term position. <a href="#6735053643dd5aca94a6f7da4272c69b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#5d7f013b3c5f259926c642765a87c0e1">set_termpos</a> (<a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> <a class="el" href="namespaceXapian.html#2de139bd007f8cbe058d526cb311ebe4">termpos</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current term position. <a href="#5d7f013b3c5f259926c642765a87c0e1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#6ed9e1db9a94986cadacf54309e4f931">get_description</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#6ed9e1db9a94986cadacf54309e4f931"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Parses a piece of text and generate terms.
<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>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="a793933bd92db66e2e61c053326ae053"></a><!-- doxytag: member="Xapian::TermGenerator::flags" ref="a793933bd92db66e2e61c053326ae053" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053">Xapian::TermGenerator::flags</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flags to OR together and pass to <a class="el" href="classXapian_1_1TermGenerator.html#37e53a10371973c306004af9ffc1c971" title="Set flags.">TermGenerator::set_flags()</a>.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="a793933bd92db66e2e61c053326ae053a5d780146641afe79cf0d02586a569bd"></a><!-- doxytag: member="FLAG_SPELLING" ref="a793933bd92db66e2e61c053326ae053a5d780146641afe79cf0d02586a569bd" args="" -->FLAG_SPELLING</em> </td><td>
Index data required for spelling correction. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e5ee7c7bda5a0eeac559a2c7cf89012d"></a><!-- doxytag: member="Xapian::TermGenerator::TermGenerator" ref="e5ee7c7bda5a0eeac559a2c7cf89012d" args="(const TermGenerator &o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::TermGenerator::TermGenerator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a> & </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<p>
</div>
</div><p>
<a class="anchor" name="45687397c5e42377b7e421426e76e03f"></a><!-- doxytag: member="Xapian::TermGenerator::TermGenerator" ref="45687397c5e42377b7e421426e76e03f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::TermGenerator::TermGenerator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
</div>
</div><p>
<a class="anchor" name="5c680d9f115a755a2c40c2855b98ce04"></a><!-- doxytag: member="Xapian::TermGenerator::~TermGenerator" ref="5c680d9f115a755a2c40c2855b98ce04" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::TermGenerator::~TermGenerator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1b660c4e818080543dc934b5c282f445"></a><!-- doxytag: member="Xapian::TermGenerator::operator=" ref="1b660c4e818080543dc934b5c282f445" args="(const TermGenerator &o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a>& Xapian::TermGenerator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a> & </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment.
<p>
</div>
</div><p>
<a class="anchor" name="f7d43aef10aa6b26ef853a0ae2695f83"></a><!-- doxytag: member="Xapian::TermGenerator::set_stemmer" ref="f7d43aef10aa6b26ef853a0ae2695f83" args="(const Xapian::Stem &stemmer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::set_stemmer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Stem.html">Xapian::Stem</a> & </td>
<td class="paramname"> <em>stemmer</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
<p>
</div>
</div><p>
<a class="anchor" name="429fd0baaee382c4f30d44de253c535e"></a><!-- doxytag: member="Xapian::TermGenerator::set_stopper" ref="429fd0baaee382c4f30d44de253c535e" args="(const Xapian::Stopper *stop=NULL)" -->
<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 width="100%"></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>
Stemmed forms of stopwords aren't indexed, but unstemmed forms still are so that searches for phrases including stop words still work.
</div>
</div><p>
<a class="anchor" name="4f37bc778dfe7e1b0fdbed3a63360f4f"></a><!-- doxytag: member="Xapian::TermGenerator::set_document" ref="4f37bc778dfe7e1b0fdbed3a63360f4f" args="(const Xapian::Document &doc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::set_document </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> & </td>
<td class="paramname"> <em>doc</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the current document.
<p>
</div>
</div><p>
<a class="anchor" name="98a15106b882b435a4e4e1409fb27200"></a><!-- doxytag: member="Xapian::TermGenerator::get_document" ref="98a15106b882b435a4e4e1409fb27200" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a>& Xapian::TermGenerator::get_document </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current document.
<p>
</div>
</div><p>
<a class="anchor" name="7e5241b4d926e9d5cb453563426b0b12"></a><!-- doxytag: member="Xapian::TermGenerator::set_database" ref="7e5241b4d926e9d5cb453563426b0b12" args="(const Xapian::WritableDatabase &db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::TermGenerator::set_database </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1WritableDatabase.html">Xapian::WritableDatabase</a> & </td>
<td class="paramname"> <em>db</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the database to index spelling data to.
<p>
</div>
</div><p>
<a class="anchor" name="37e53a10371973c306004af9ffc1c971"></a><!-- doxytag: member="Xapian::TermGenerator::set_flags" ref="37e53a10371973c306004af9ffc1c971" args="(flags toggle, flags mask=flags(0))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053">flags</a> Xapian::TermGenerator::set_flags </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053">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#a793933bd92db66e2e61c053326ae053">flags</a> </td>
<td class="paramname"> <em>mask</em> = <code><a class="el" href="classXapian_1_1TermGenerator.html#a793933bd92db66e2e61c053326ae053">flags</a>(0)</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set flags.
<p>
The new value of flags is: (flags & mask) ^ toggle<p>
To just set the flags, pass the new flags in toggle and the default value for mask.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>toggle</em> </td><td>Flags to XOR. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mask</em> </td><td>Flags to AND with first.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The old flags setting. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4417b6d1e3c1bfcf06148945e2301a26"></a><!-- doxytag: member="Xapian::TermGenerator::index_text" ref="4417b6d1e3c1bfcf06148945e2301a26" args="(const Xapian::Utf8Iterator &itor, Xapian::termcount weight=1, const std::string &prefix="")" -->
<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#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td>
<td class="paramname"> <em>weight</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>""</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Index some text.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>weight</em> </td><td>The wdf increment (default 1). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>The term prefix to use (default is no prefix). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b358784fa685139e8bdd71d37f39573e"></a><!-- doxytag: member="Xapian::TermGenerator::index_text" ref="b358784fa685139e8bdd71d37f39573e" args="(const std::string &text, Xapian::termcount weight=1, const std::string &prefix="")" -->
<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 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#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td>
<td class="paramname"> <em>weight</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>""</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Index some text in a std::string.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>weight</em> </td><td>The wdf increment (default 1). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>The term prefix to use (default is no prefix). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3f34e96855bd8288564c91ff355a1978"></a><!-- doxytag: member="Xapian::TermGenerator::index_text_without_positions" ref="3f34e96855bd8288564c91ff355a1978" args="(const Xapian::Utf8Iterator &itor, Xapian::termcount weight=1, const std::string &prefix="")" -->
<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#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td>
<td class="paramname"> <em>weight</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>""</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Index some text without positional information.
<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.
</div>
</div><p>
<a class="anchor" name="62240a160aedf37baf67144b9681dcd6"></a><!-- doxytag: member="Xapian::TermGenerator::index_text_without_positions" ref="62240a160aedf37baf67144b9681dcd6" args="(const std::string &text, Xapian::termcount weight=1, const std::string &prefix="")" -->
<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 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#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td>
<td class="paramname"> <em>weight</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>""</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Index some text in a std::string without positional information.
<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.
</div>
</div><p>
<a class="anchor" name="d416c0d61264440d8ee2b42f46118d9f"></a><!-- doxytag: member="Xapian::TermGenerator::increase_termpos" ref="d416c0d61264440d8ee2b42f46118d9f" args="(Xapian::termcount delta=100)" -->
<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#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td>
<td class="paramname"> <em>delta</em> = <code>100</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Increase the termpos used by index_text by <em>delta</em>.
<p>
This can be used to prevent phrase searches from spanning two unconnected blocks of text (e.g. the title and body text).
</div>
</div><p>
<a class="anchor" name="6735053643dd5aca94a6f7da4272c69b"></a><!-- doxytag: member="Xapian::TermGenerator::get_termpos" ref="6735053643dd5aca94a6f7da4272c69b" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> Xapian::TermGenerator::get_termpos </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current term position.
<p>
</div>
</div><p>
<a class="anchor" name="5d7f013b3c5f259926c642765a87c0e1"></a><!-- doxytag: member="Xapian::TermGenerator::set_termpos" ref="5d7f013b3c5f259926c642765a87c0e1" args="(Xapian::termcount termpos)" -->
<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#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td>
<td class="paramname"> <em>termpos</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the current term position.
<p>
</div>
</div><p>
<a class="anchor" name="6ed9e1db9a94986cadacf54309e4f931"></a><!-- doxytag: member="Xapian::TermGenerator::get_description" ref="6ed9e1db9a94986cadacf54309e4f931" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::TermGenerator::get_description </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a string describing this object.
<p>
</div>
</div><p>
<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></ul>
<hr>
<address><small>
Documentation for Xapian (version 1.0.21).<br>
Generated on 18 Jun 2010 by
<a href="http://www.doxygen.org/">Doxygen 1.5.2</a>.
</small></address>
</body>
</html>
