1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::ValueSetMatchDecider 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_1ValueSetMatchDecider.html">ValueSetMatchDecider</a>
</div>
</div>
<div class="contents">
<h1>Xapian::ValueSetMatchDecider Class Reference</h1><!-- doxytag: class="Xapian::ValueSetMatchDecider" --><!-- doxytag: inherits="Xapian::MatchDecider" --><a class="el" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor.">MatchDecider</a> filtering results based on whether document values are in a user-defined set.
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for Xapian::ValueSetMatchDecider:</div>
<div class="dynsection">
<p><center><img src="classXapian_1_1ValueSetMatchDecider__inherit__graph.png" border="0" usemap="#Xapian_1_1ValueSetMatchDecider__inherit__map" alt="Inheritance graph"></center>
<map name="Xapian_1_1ValueSetMatchDecider__inherit__map">
<area shape="rect" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor." alt="" coords="33,7,193,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classXapian_1_1ValueSetMatchDecider-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_1ValueSetMatchDecider.html#1f63ce5e07042150e324c754e3a98d09">ValueSetMatchDecider</a> (<a class="el" href="namespaceXapian.html#94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot, bool inclusive_)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1ValueSetMatchDecider.html" title="MatchDecider filtering results based on whether document values are in a user-defined...">ValueSetMatchDecider</a>. <a href="#1f63ce5e07042150e324c754e3a98d09"></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_1ValueSetMatchDecider.html#c7ea29abdfff5425ea6e75a318b1c961">add_value</a> (const std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a value to the test set. <a href="#c7ea29abdfff5425ea6e75a318b1c961"></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_1ValueSetMatchDecider.html#2ee026448fcb6501703949cf201f0487">remove_value</a> (const std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a value from the test set. <a href="#2ee026448fcb6501703949cf201f0487"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueSetMatchDecider.html#c36090a4892dec25b5bdc1e8efaeacba">operator()</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &doc) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decide whether we want a particular document to be in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#c36090a4892dec25b5bdc1e8efaeacba"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor.">MatchDecider</a> filtering results based on whether document values are in a user-defined set. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1f63ce5e07042150e324c754e3a98d09"></a><!-- doxytag: member="Xapian::ValueSetMatchDecider::ValueSetMatchDecider" ref="1f63ce5e07042150e324c754e3a98d09" args="(Xapian::valueno slot, bool inclusive_)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::ValueSetMatchDecider::ValueSetMatchDecider </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"> <em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>inclusive_</em></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>
Construct a <a class="el" href="classXapian_1_1ValueSetMatchDecider.html" title="MatchDecider filtering results based on whether document values are in a user-defined...">ValueSetMatchDecider</a>.
<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>slot</em> </td><td>The value slot number to look in.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>inclusive_</em> </td><td>If true, match decider accepts documents which have a value in the specified slot which is a member of the test set; if false, match decider accepts documents which do not have a value in the specified slot. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c7ea29abdfff5425ea6e75a318b1c961"></a><!-- doxytag: member="Xapian::ValueSetMatchDecider::add_value" ref="c7ea29abdfff5425ea6e75a318b1c961" args="(const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::ValueSetMatchDecider::add_value </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a value to the test set.
<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>value</em> </td><td>The value to add to the test set. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c36090a4892dec25b5bdc1e8efaeacba"></a><!-- doxytag: member="Xapian::ValueSetMatchDecider::operator()" ref="c36090a4892dec25b5bdc1e8efaeacba" args="(const Xapian::Document &doc) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::ValueSetMatchDecider::operator() </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> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decide whether we want a particular document to be in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<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>doc</em> </td><td>The document to test. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the document is acceptable, or false if the document should be excluded from the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. </dd></dl>
<p>Implements <a class="el" href="classXapian_1_1MatchDecider.html#1c3b5b4b318521132024cd80df0ff2c3">Xapian::MatchDecider</a>.</p>
</div>
</div><p>
<a class="anchor" name="2ee026448fcb6501703949cf201f0487"></a><!-- doxytag: member="Xapian::ValueSetMatchDecider::remove_value" ref="2ee026448fcb6501703949cf201f0487" args="(const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::ValueSetMatchDecider::remove_value </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a value from the test set.
<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>value</em> </td><td>The value to remove from the test 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="valuesetmatchdecider_8h.html">valuesetmatchdecider.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>
|