<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::MatchSpy 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_1MatchSpy.html">MatchSpy</a>
</div>
</div>
<div class="contents">
<h1>Xapian::MatchSpy Class Reference</h1><!-- doxytag: class="Xapian::MatchSpy" -->Abstract base class for match spies.
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for Xapian::MatchSpy:</div>
<div class="dynsection">
<p><center><img src="classXapian_1_1MatchSpy__inherit__graph.png" border="0" usemap="#Xapian_1_1MatchSpy__inherit__map" alt="Inheritance graph"></center>
<map name="Xapian_1_1MatchSpy__inherit__map">
<area shape="rect" href="classXapian_1_1ValueCountMatchSpy.html" title="Class for counting the frequencies of values in the matching documents." alt="" coords="5,84,213,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classXapian_1_1MatchSpy-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#33eef1126286858ed6c9908028dcae5b">~MatchSpy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor, because we have virtual methods. <a href="#33eef1126286858ed6c9908028dcae5b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#1d4a22970c8042a0bd697b473625f9bf">operator()</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &doc, <a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> wt)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a document with the match spy. <a href="#1d4a22970c8042a0bd697b473625f9bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#d172b16efde32cf0dcbb0fb6fb43dc33">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clone the match spy. <a href="#d172b16efde32cf0dcbb0fb6fb43dc33"></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_1MatchSpy.html#4f7e79243aed9b81fba8a6c7f9500f0f">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of this match spy. <a href="#4f7e79243aed9b81fba8a6c7f9500f0f"></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_1MatchSpy.html#59b3e4c181f9dc78e78609949ffe6ec7">serialise</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return this object's parameters serialised as a single string. <a href="#59b3e4c181f9dc78e78609949ffe6ec7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#8ddda381134be9b9d973e746753ad3e2">unserialise</a> (const std::string &s, const <a class="el" href="classXapian_1_1Registry.html">Registry</a> &context) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unserialise parameters. <a href="#8ddda381134be9b9d973e746753ad3e2"></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_1MatchSpy.html#3892fcdd67c425ff1ba493e2ac397ce9">serialise_results</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Serialise the results of this match spy. <a href="#3892fcdd67c425ff1ba493e2ac397ce9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#921014b484002f909cd9649477e25c81">merge_results</a> (const std::string &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unserialise some results, and merge them into this matchspy. <a href="#921014b484002f909cd9649477e25c81"></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_1MatchSpy.html#b12e942f6657c86938cb83a55febc4e2">get_description</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#b12e942f6657c86938cb83a55febc4e2"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6f1b24d1ef113cf625ce75b6320212ed"></a><!-- doxytag: member="Xapian::MatchSpy::MatchSpy" ref="6f1b24d1ef113cf625ce75b6320212ed" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#6f1b24d1ef113cf625ce75b6320212ed">MatchSpy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor, needed by subclass constructors. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract base class for match spies.
<p>
The subclasses will generally accumulate information seen during the match, to calculate aggregate functions, or other profiles of the matching documents. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="33eef1126286858ed6c9908028dcae5b"></a><!-- doxytag: member="Xapian::MatchSpy::~MatchSpy" ref="33eef1126286858ed6c9908028dcae5b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Xapian::MatchSpy::~MatchSpy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Virtual destructor, because we have virtual methods.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d172b16efde32cf0dcbb0fb6fb43dc33"></a><!-- doxytag: member="Xapian::MatchSpy::clone" ref="d172b16efde32cf0dcbb0fb6fb43dc33" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a>* Xapian::MatchSpy::clone </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clone the match spy.
<p>
The clone should inherit the configuration of the parent, but need not inherit the state. ie, the clone does not need to be passed information about the results seen by the parent.<p>
If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.<p>
Note that the returned object will be deallocated by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> API for use from another language) then you can define a static <code>operator delete</code> method in your subclass as shown here: <a href="http://trac.xapian.org/ticket/554#comment:1">http://trac.xapian.org/ticket/554#comment:1</a>
<p>Reimplemented in <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#2f3f76f7a269b15b22e5f266a166ed00">Xapian::ValueCountMatchSpy</a>.</p>
</div>
</div><p>
<a class="anchor" name="b12e942f6657c86938cb83a55febc4e2"></a><!-- doxytag: member="Xapian::MatchSpy::get_description" ref="b12e942f6657c86938cb83a55febc4e2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::MatchSpy::get_description </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a string describing this object.
<p>
This default implementation returns a generic answer, to avoid forcing those deriving their own <a class="el" href="classXapian_1_1MatchSpy.html" title="Abstract base class for match spies.">MatchSpy</a> subclasses from having to implement this (they may not care what <a class="el" href="classXapian_1_1MatchSpy.html#b12e942f6657c86938cb83a55febc4e2" title="Return a string describing this object.">get_description()</a> gives for their subclass).
<p>Reimplemented in <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#350eb6f93aa5e01845a56f2fd30391f8">Xapian::ValueCountMatchSpy</a>.</p>
</div>
</div><p>
<a class="anchor" name="921014b484002f909cd9649477e25c81"></a><!-- doxytag: member="Xapian::MatchSpy::merge_results" ref="921014b484002f909cd9649477e25c81" args="(const std::string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Xapian::MatchSpy::merge_results </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>s</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unserialise some results, and merge them into this matchspy.
<p>
The order in which results are merged should not be significant, since this order is not specified (and will vary depending on the speed of the search in each sub-database).<p>
If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</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>s</em> </td><td>A string containing the serialised results. </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#cc26d27271e945dc555c8f981b4fe775">Xapian::ValueCountMatchSpy</a>.</p>
</div>
</div><p>
<a class="anchor" name="4f7e79243aed9b81fba8a6c7f9500f0f"></a><!-- doxytag: member="Xapian::MatchSpy::name" ref="4f7e79243aed9b81fba8a6c7f9500f0f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::MatchSpy::name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the name of this match spy.
<p>
This name is used by the remote backend. It is passed with the serialised parameters to the remote server so that it knows which class to create.<p>
Return the full namespace-qualified name of your class here - if your class is called MyApp::FooMatchSpy, return "MyApp::FooMatchSpy" from this method.<p>
If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.
<p>Reimplemented in <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#0156235fbae335975efe173cad85ea0a">Xapian::ValueCountMatchSpy</a>.</p>
</div>
</div><p>
<a class="anchor" name="1d4a22970c8042a0bd697b473625f9bf"></a><!-- doxytag: member="Xapian::MatchSpy::operator()" ref="1d4a22970c8042a0bd697b473625f9bf" args="(const Xapian::Document &doc, Xapian::weight wt)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Xapian::MatchSpy::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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td>
<td class="paramname"> <em>wt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register a document with the match spy.
<p>
This is called by the matcher once with each document seen by the matcher during the match process. Note that the matcher will often not see all the documents which match the query, due to optimisations which allow low-weighted documents to be skipped, and allow the match process to be terminated early.<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 seen by the match spy. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>wt</em> </td><td>The weight of the document. </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#ba74fcbd87fa4a173d7cc6b7a26567d4">Xapian::ValueCountMatchSpy</a>.</p>
</div>
</div><p>
<a class="anchor" name="59b3e4c181f9dc78e78609949ffe6ec7"></a><!-- doxytag: member="Xapian::MatchSpy::serialise" ref="59b3e4c181f9dc78e78609949ffe6ec7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::MatchSpy::serialise </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return this object's parameters serialised as a single string.
<p>
If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.
<p>Reimplemented in <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#4b0b12f88a83fa854160d62d3f0b1a66">Xapian::ValueCountMatchSpy</a>.</p>
</div>
</div><p>
<a class="anchor" name="3892fcdd67c425ff1ba493e2ac397ce9"></a><!-- doxytag: member="Xapian::MatchSpy::serialise_results" ref="3892fcdd67c425ff1ba493e2ac397ce9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::MatchSpy::serialise_results </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Serialise the results of this match spy.
<p>
If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.
<p>Reimplemented in <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#bf75525e101f358d07750abc466115da">Xapian::ValueCountMatchSpy</a>.</p>
</div>
</div><p>
<a class="anchor" name="8ddda381134be9b9d973e746753ad3e2"></a><!-- doxytag: member="Xapian::MatchSpy::unserialise" ref="8ddda381134be9b9d973e746753ad3e2" args="(const std::string &s, const Registry &context) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a>* Xapian::MatchSpy::unserialise </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Registry.html">Registry</a> & </td>
<td class="paramname"> <em>context</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unserialise parameters.
<p>
This method unserialises parameters serialised by the <em><a class="el" href="classXapian_1_1MatchSpy.html#59b3e4c181f9dc78e78609949ffe6ec7" title="Return this object's parameters serialised as a single string.">serialise()</a></em> method and allocates and returns a new object initialised with them.<p>
If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.<p>
Note that the returned object will be deallocated by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> API for use from another language) then you can define a static <code>operator delete</code> method in your subclass as shown here: <a href="http://trac.xapian.org/ticket/554#comment:1">http://trac.xapian.org/ticket/554#comment:1</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>s</em> </td><td>A string containing the serialised results. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td><a class="el" href="classXapian_1_1Registry.html" title="Registry for user subclasses.">Registry</a> object to use for unserialisation to permit <a class="el" href="classXapian_1_1MatchSpy.html" title="Abstract base class for match spies.">MatchSpy</a> subclasses with sub-MatchSpy objects to be implemented. </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#00c8fb9751f52c6f4a6610e23b130690">Xapian::ValueCountMatchSpy</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="matchspy_8h.html">matchspy.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>
