<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::SimpleStopper 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_1SimpleStopper.html">SimpleStopper</a>
</div>
</div>
<div class="contents">
<h1>Xapian::SimpleStopper Class Reference</h1><!-- doxytag: class="Xapian::SimpleStopper" --><!-- doxytag: inherits="Xapian::Stopper" -->Simple implementation of <a class="el" href="classXapian_1_1Stopper.html" title="Base class for stop-word decision functor.">Stopper</a> class - this will suit most users.
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for Xapian::SimpleStopper:</div>
<div class="dynsection">
<p><center><img src="classXapian_1_1SimpleStopper__inherit__graph.png" border="0" usemap="#Xapian_1_1SimpleStopper__inherit__map" alt="Inheritance graph"></center>
<map name="Xapian_1_1SimpleStopper__inherit__map">
<area shape="rect" href="classXapian_1_1Stopper.html" title="Base class for stop-word decision functor." alt="" coords="28,7,151,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classXapian_1_1SimpleStopper-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="524d06efe68acee3358809108b5ad22e"></a><!-- doxytag: member="Xapian::SimpleStopper::SimpleStopper" ref="524d06efe68acee3358809108b5ad22e" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#524d06efe68acee3358809108b5ad22e">SimpleStopper</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="a11bad1a50af1488a138fac82613e2c7"></a><!-- doxytag: member="Xapian::SimpleStopper::SimpleStopper" ref="a11bad1a50af1488a138fac82613e2c7" args="(Iterator begin, Iterator end)" -->
template<class Iterator > </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#a11bad1a50af1488a138fac82613e2c7">SimpleStopper</a> (Iterator begin, Iterator end)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise from a pair of iterators. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="48b8ce2de81a61460911adc065ba8afb"></a><!-- doxytag: member="Xapian::SimpleStopper::add" ref="48b8ce2de81a61460911adc065ba8afb" args="(const std::string &word)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#48b8ce2de81a61460911adc065ba8afb">add</a> (const std::string &word)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a single stop word. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#56543c160db0b45ab73b5789864a3cda">operator()</a> (const std::string &term) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is term a stop-word? <a href="#56543c160db0b45ab73b5789864a3cda"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb0bddbf6805b12f760e707032f4cbb3"></a><!-- doxytag: member="Xapian::SimpleStopper::get_description" ref="eb0bddbf6805b12f760e707032f4cbb3" args="() const " -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#eb0bddbf6805b12f760e707032f4cbb3">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>
Simple implementation of <a class="el" href="classXapian_1_1Stopper.html" title="Base class for stop-word decision functor.">Stopper</a> class - this will suit most users. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="56543c160db0b45ab73b5789864a3cda"></a><!-- doxytag: member="Xapian::SimpleStopper::operator()" ref="56543c160db0b45ab73b5789864a3cda" args="(const std::string &term) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool Xapian::SimpleStopper::operator() </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>term</em> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Is term a stop-word?
<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>term</em> </td><td>The term to test. </td></tr>
</table>
</dl>
<p>Implements <a class="el" href="classXapian_1_1Stopper.html#28c9649a93987abb97d06998a146d6fe">Xapian::Stopper</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="queryparser_8h.html">queryparser.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>
