<!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.9 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a>
</div>
</div>
<div class="contents">
<h1>Xapian::TermGenerator Class Reference</h1><!-- doxytag: class="Xapian::TermGenerator" -->Parses a piece of text and generate terms.
<a href="#_details">More...</a>
<p>
<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#76e983a417d996ebf729999150f45017">flags</a> { <a class="el" href="classXapian_1_1TermGenerator.html#76e983a417d996ebf729999150f45017652e030497621117c43e21e6c23035d8">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#a0d1f0ee309227852654e589ef441517" title="Set flags.">TermGenerator::set_flags()</a>. <a href="classXapian_1_1TermGenerator.html#76e983a417d996ebf729999150f45017">More...</a><br></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#601e0430b9c2c91831a76f8f40d50ce1">stem_strategy</a> </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stemming strategies, for use with <a class="el" href="classXapian_1_1TermGenerator.html#5046d3579a0eb7173ab615cbe5e99ee8" title="Set the stemming strategy.">set_stemming_strategy()</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"><a class="anchor" name="331dd5585658fc56baf91de4617f3ffd"></a><!-- doxytag: member="Xapian::TermGenerator::TermGenerator" ref="331dd5585658fc56baf91de4617f3ffd" args="(const TermGenerator &o)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#331dd5585658fc56baf91de4617f3ffd">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="532945e0a6f0bbc98119ea5298d254de"></a><!-- doxytag: member="Xapian::TermGenerator::operator=" ref="532945e0a6f0bbc98119ea5298d254de" args="(const TermGenerator &o)" -->
<a class="el" href="classXapian_1_1TermGenerator.html">TermGenerator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#532945e0a6f0bbc98119ea5298d254de">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bfcaae65a459d31b5497154847213bbc"></a><!-- doxytag: member="Xapian::TermGenerator::TermGenerator" ref="bfcaae65a459d31b5497154847213bbc" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#bfcaae65a459d31b5497154847213bbc">TermGenerator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8f5c0681963870e37a5b0f66be32819"></a><!-- doxytag: member="Xapian::TermGenerator::~TermGenerator" ref="c8f5c0681963870e37a5b0f66be32819" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#c8f5c0681963870e37a5b0f66be32819">~TermGenerator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8813a97565e16d547183337e7647b711"></a><!-- doxytag: member="Xapian::TermGenerator::set_stemmer" ref="8813a97565e16d547183337e7647b711" args="(const Xapian::Stem &stemmer)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#8813a97565e16d547183337e7647b711">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. <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#8cef8e7b696129a0fc311e47baaf2120">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="#8cef8e7b696129a0fc311e47baaf2120"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f478b20d2a088697368dc2c1f1045675"></a><!-- doxytag: member="Xapian::TermGenerator::set_document" ref="f478b20d2a088697368dc2c1f1045675" args="(const Xapian::Document &doc)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#f478b20d2a088697368dc2c1f1045675">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9db48a0ef7ddc8846bf515c32d6551c"></a><!-- doxytag: member="Xapian::TermGenerator::get_document" ref="d9db48a0ef7ddc8846bf515c32d6551c" args="() const " -->
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#d9db48a0ef7ddc8846bf515c32d6551c">get_document</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current document. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="56edabc2673241bcd87c3bd6b65e9c6d"></a><!-- doxytag: member="Xapian::TermGenerator::set_database" ref="56edabc2673241bcd87c3bd6b65e9c6d" args="(const Xapian::WritableDatabase &db)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#56edabc2673241bcd87c3bd6b65e9c6d">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1TermGenerator.html#76e983a417d996ebf729999150f45017">flags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#a0d1f0ee309227852654e589ef441517">set_flags</a> (<a class="el" href="classXapian_1_1TermGenerator.html#76e983a417d996ebf729999150f45017">flags</a> toggle, <a class="el" href="classXapian_1_1TermGenerator.html#76e983a417d996ebf729999150f45017">flags</a> mask=<a class="el" href="classXapian_1_1TermGenerator.html#76e983a417d996ebf729999150f45017">flags</a>(0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set flags. <a href="#a0d1f0ee309227852654e589ef441517"></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#5046d3579a0eb7173ab615cbe5e99ee8">set_stemming_strategy</a> (<a class="el" href="classXapian_1_1TermGenerator.html#601e0430b9c2c91831a76f8f40d50ce1">stem_strategy</a> strategy)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the stemming strategy. <a href="#5046d3579a0eb7173ab615cbe5e99ee8"></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#6916b0233aa4c326711667d2195db4d7">index_text</a> (const <a class="el" href="classXapian_1_1Utf8Iterator.html">Xapian::Utf8Iterator</a> &itor, <a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> wdf_inc=1, const std::string &prefix=std::string())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index some text. <a href="#6916b0233aa4c326711667d2195db4d7"></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#5d98ef5625fe146e56b790c9c31c05f4">index_text</a> (const std::string &text, <a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> wdf_inc=1, const std::string &prefix=std::string())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index some text in a std::string. <a href="#5d98ef5625fe146e56b790c9c31c05f4"></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#a34cc9a0646793c4f5b9b56b2ec3c9a6">index_text_without_positions</a> (const <a class="el" href="classXapian_1_1Utf8Iterator.html">Xapian::Utf8Iterator</a> &itor, <a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> wdf_inc=1, const std::string &prefix=std::string())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index some text without positional information. <a href="#a34cc9a0646793c4f5b9b56b2ec3c9a6"></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#9190f956783d94c9b699a2590aaaea43">index_text_without_positions</a> (const std::string &text, <a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> wdf_inc=1, const std::string &prefix=std::string())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index some text in a std::string without positional information. <a href="#9190f956783d94c9b699a2590aaaea43"></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#79bd3a43ad8c9d1b711ec61ae9107e5f">increase_termpos</a> (<a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> delta=100)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increase the term position used by index_text. <a href="#79bd3a43ad8c9d1b711ec61ae9107e5f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0ed8b94c99912892feb4b77a53a817e9"></a><!-- doxytag: member="Xapian::TermGenerator::get_termpos" ref="0ed8b94c99912892feb4b77a53a817e9" args="() const " -->
<a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#0ed8b94c99912892feb4b77a53a817e9">get_termpos</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current term position. <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#30b644e5568a225c7da9805774a4ebb4">set_termpos</a> (<a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> <a class="el" href="namespaceXapian.html#e5a16f073d0c8ed54085a9de07248d45">termpos</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current term position. <a href="#30b644e5568a225c7da9805774a4ebb4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="61868ef6d88b24f5395401fdfd4c7ec0"></a><!-- doxytag: member="Xapian::TermGenerator::get_description" ref="61868ef6d88b24f5395401fdfd4c7ec0" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1TermGenerator.html#61868ef6d88b24f5395401fdfd4c7ec0">get_description</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <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. <hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="76e983a417d996ebf729999150f45017"></a><!-- doxytag: member="Xapian::TermGenerator::flags" ref="76e983a417d996ebf729999150f45017" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classXapian_1_1TermGenerator.html#76e983a417d996ebf729999150f45017">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#a0d1f0ee309227852654e589ef441517" 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="76e983a417d996ebf729999150f45017652e030497621117c43e21e6c23035d8"></a><!-- doxytag: member="FLAG_SPELLING" ref="76e983a417d996ebf729999150f45017652e030497621117c43e21e6c23035d8" args="" -->FLAG_SPELLING</em> </td><td>
Index data required for spelling correction. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="79bd3a43ad8c9d1b711ec61ae9107e5f"></a><!-- doxytag: member="Xapian::TermGenerator::increase_termpos" ref="79bd3a43ad8c9d1b711ec61ae9107e5f" 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#72b5a76dd8cfb7b251fe7986e86390cb">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>
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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>delta</em> </td><td>Amount to increase the term position by (default: 100). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5d98ef5625fe146e56b790c9c31c05f4"></a><!-- doxytag: member="Xapian::TermGenerator::index_text" ref="5d98ef5625fe146e56b790c9c31c05f4" args="(const std::string &text, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())" -->
<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#72b5a76dd8cfb7b251fe7986e86390cb">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><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>text</em> </td><td>The text to index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>wdf_inc</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="6916b0233aa4c326711667d2195db4d7"></a><!-- doxytag: member="Xapian::TermGenerator::index_text" ref="6916b0233aa4c326711667d2195db4d7" args="(const Xapian::Utf8Iterator &itor, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())" -->
<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#72b5a76dd8cfb7b251fe7986e86390cb">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></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>itor</em> </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 valign="top"></td><td valign="top"><em>wdf_inc</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="9190f956783d94c9b699a2590aaaea43"></a><!-- doxytag: member="Xapian::TermGenerator::index_text_without_positions" ref="9190f956783d94c9b699a2590aaaea43" args="(const std::string &text, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())" -->
<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#72b5a76dd8cfb7b251fe7986e86390cb">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><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.<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>text</em> </td><td>The text to index. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>wdf_inc</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="a34cc9a0646793c4f5b9b56b2ec3c9a6"></a><!-- doxytag: member="Xapian::TermGenerator::index_text_without_positions" ref="a34cc9a0646793c4f5b9b56b2ec3c9a6" args="(const Xapian::Utf8Iterator &itor, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())" -->
<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#72b5a76dd8cfb7b251fe7986e86390cb">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></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.<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>itor</em> </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 valign="top"></td><td valign="top"><em>wdf_inc</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="a0d1f0ee309227852654e589ef441517"></a><!-- doxytag: member="Xapian::TermGenerator::set_flags" ref="a0d1f0ee309227852654e589ef441517" 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#76e983a417d996ebf729999150f45017">flags</a> Xapian::TermGenerator::set_flags </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1TermGenerator.html#76e983a417d996ebf729999150f45017">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#76e983a417d996ebf729999150f45017">flags</a> </td>
<td class="paramname"> <em>mask</em> = <code><a class="el" href="classXapian_1_1TermGenerator.html#76e983a417d996ebf729999150f45017">flags</a>(0)</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></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="5046d3579a0eb7173ab615cbe5e99ee8"></a><!-- doxytag: member="Xapian::TermGenerator::set_stemming_strategy" ref="5046d3579a0eb7173ab615cbe5e99ee8" args="(stem_strategy strategy)" -->
<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#601e0430b9c2c91831a76f8f40d50ce1">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>
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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>strategy</em> </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>
</dl>
</div>
</div><p>
<a class="anchor" name="8cef8e7b696129a0fc311e47baaf2120"></a><!-- doxytag: member="Xapian::TermGenerator::set_stopper" ref="8cef8e7b696129a0fc311e47baaf2120" 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></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.<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>stop</em> </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>
</dl>
</div>
</div><p>
<a class="anchor" name="30b644e5568a225c7da9805774a4ebb4"></a><!-- doxytag: member="Xapian::TermGenerator::set_termpos" ref="30b644e5568a225c7da9805774a4ebb4" 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#72b5a76dd8cfb7b251fe7986e86390cb">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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>termpos</em> </td><td>The new term position to set. </td></tr>
</table>
</dl>
</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>
</div>
<hr>
<address><small>
Documentation for Xapian (version 1.2.12).<br>
Generated on 27 Jun 2012 by
<a href="http://www.doxygen.org/">Doxygen 1.5.9</a>.
</small></address>
</body>
</html>
