<!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.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_1SimpleStopper.html">SimpleStopper</a></div>
<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>
Inheritance diagram for Xapian::SimpleStopper:<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><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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#e176887e468b7750941876f903a53527">SimpleStopper</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#e176887e468b7750941876f903a53527"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">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#28783391148b0dbcb6fa3ce5d1bd7729">SimpleStopper</a> (Iterator begin, Iterator end)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise from a pair of iterators. <a href="#28783391148b0dbcb6fa3ce5d1bd7729"></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_1SimpleStopper.html#4d248b83270389facc95a343bf17b50f">add</a> (const std::string &word)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a single stop word. <a href="#4d248b83270389facc95a343bf17b50f"></a><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#5fce89127d4f439edc0b8da4ed231fa4">operator()</a> (const std::string &term) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is term a stop-word? <a href="#5fce89127d4f439edc0b8da4ed231fa4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#da91916ae36fa08a1e554151fdb9e9d1">~SimpleStopper</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#da91916ae36fa08a1e554151fdb9e9d1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#7daccba0b8d7642faebe9ddd89894bb8">get_description</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#7daccba0b8d7642faebe9ddd89894bb8"></a><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.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e176887e468b7750941876f903a53527"></a><!-- doxytag: member="Xapian::SimpleStopper::SimpleStopper" ref="e176887e468b7750941876f903a53527" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::SimpleStopper::SimpleStopper </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
</div>
</div><p>
<a class="anchor" name="28783391148b0dbcb6fa3ce5d1bd7729"></a><!-- doxytag: member="Xapian::SimpleStopper::SimpleStopper" ref="28783391148b0dbcb6fa3ce5d1bd7729" args="(Iterator begin, Iterator end)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Iterator> </div>
<table class="memname">
<tr>
<td class="memname">Xapian::SimpleStopper::SimpleStopper </td>
<td>(</td>
<td class="paramtype">Iterator </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Iterator </td>
<td class="paramname"> <em>end</em></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>
Initialise from a pair of iterators.
<p>
</div>
</div><p>
<a class="anchor" name="da91916ae36fa08a1e554151fdb9e9d1"></a><!-- doxytag: member="Xapian::SimpleStopper::~SimpleStopper" ref="da91916ae36fa08a1e554151fdb9e9d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Xapian::SimpleStopper::~SimpleStopper </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4d248b83270389facc95a343bf17b50f"></a><!-- doxytag: member="Xapian::SimpleStopper::add" ref="4d248b83270389facc95a343bf17b50f" args="(const std::string &word)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::SimpleStopper::add </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>word</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a single stop word.
<p>
</div>
</div><p>
<a class="anchor" name="5fce89127d4f439edc0b8da4ed231fa4"></a><!-- doxytag: member="Xapian::SimpleStopper::operator()" ref="5fce89127d4f439edc0b8da4ed231fa4" 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 width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Is term a stop-word?
<p>
<p>
Implements <a class="el" href="classXapian_1_1Stopper.html#e6e0c515e6aef0c93dc23824c0f752b2">Xapian::Stopper</a>.
</div>
</div><p>
<a class="anchor" name="7daccba0b8d7642faebe9ddd89894bb8"></a><!-- doxytag: member="Xapian::SimpleStopper::get_description" ref="7daccba0b8d7642faebe9ddd89894bb8" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::SimpleStopper::get_description </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a string describing this object.
<p>
<p>
Reimplemented from <a class="el" href="classXapian_1_1Stopper.html#4db60333a8b753a7ce63bf98ee3d8aa1">Xapian::Stopper</a>.
</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>
<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>
