<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::Stopper 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_1Stopper.html">Stopper</a></div>
<h1>Xapian::Stopper Class Reference</h1><!-- doxytag: class="Xapian::Stopper" -->Base class for stop-word decision functor.
<a href="#_details">More...</a>
<p>
Inheritance diagram for Xapian::Stopper:<p><center><img src="classXapian_1_1Stopper__inherit__graph.png" border="0" usemap="#Xapian_1_1Stopper__inherit__map" alt="Inheritance graph"></center>
<map name="Xapian_1_1Stopper__inherit__map">
<area shape="rect" href="classXapian_1_1SimpleStopper.html" title="Simple implementation of Stopper class - this will suit most users." alt="" coords="5,84,173,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXapian_1_1Stopper-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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stopper.html#e6e0c515e6aef0c93dc23824c0f752b2">operator()</a> (const std::string &term) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is term a stop-word? <a href="#e6e0c515e6aef0c93dc23824c0f752b2"></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_1Stopper.html#322dafff5dbe08d53798f9863e3b1b67">~Stopper</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class has virtual methods, so provide a virtual destructor. <a href="#322dafff5dbe08d53798f9863e3b1b67"></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_1Stopper.html#4db60333a8b753a7ce63bf98ee3d8aa1">get_description</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#4db60333a8b753a7ce63bf98ee3d8aa1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for stop-word decision functor.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="322dafff5dbe08d53798f9863e3b1b67"></a><!-- doxytag: member="Xapian::Stopper::~Stopper" ref="322dafff5dbe08d53798f9863e3b1b67" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Xapian::Stopper::~Stopper </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Class has virtual methods, so provide a virtual destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e6e0c515e6aef0c93dc23824c0f752b2"></a><!-- doxytag: member="Xapian::Stopper::operator()" ref="e6e0c515e6aef0c93dc23824c0f752b2" args="(const std::string &term) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool Xapian::Stopper::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> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Is term a stop-word?
<p>
<p>
Implemented in <a class="el" href="classXapian_1_1SimpleStopper.html#5fce89127d4f439edc0b8da4ed231fa4">Xapian::SimpleStopper</a>.
</div>
</div><p>
<a class="anchor" name="4db60333a8b753a7ce63bf98ee3d8aa1"></a><!-- doxytag: member="Xapian::Stopper::get_description" ref="4db60333a8b753a7ce63bf98ee3d8aa1" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::Stopper::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 in <a class="el" href="classXapian_1_1SimpleStopper.html#7daccba0b8d7642faebe9ddd89894bb8">Xapian::SimpleStopper</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>
