blob: 2ea3c652f9cda1ff1caf208197bf86ce04dca69f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Distributed.Configuration.DistributedSearcher Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html">Distributed</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed_1_1_configuration.html">Configuration</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html">DistributedSearcher</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Distributed.Configuration.DistributedSearcher Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Definition of a configurable set of search indexes made accessible by the LuceneServer windows service for a consuming application. These search indexes are defined in the configuration file of an application. The locations defined in a <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html" title="Definition of a configurable set of search indexes made accessible by the LuceneServer windows servic...">DistributedSearcher</a> match the exposed object URIs as defined in the LuceneServer service.
<a href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6af8469a7183eb319a432cefcaeed677"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html#a6af8469a7183eb319a432cefcaeed677">DistributedSearcher</a> (XmlNode xSection)</td></tr>
<tr class="memdesc:a6af8469a7183eb319a432cefcaeed677"><td class="mdescLeft">&#160;</td><td class="mdescRight">Public constructor for <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html" title="Definition of a configurable set of search indexes made accessible by the LuceneServer windows servic...">DistributedSearcher</a>. A <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html" title="Definition of a configurable set of search indexes made accessible by the LuceneServer windows servic...">DistributedSearcher</a> is defined in XML configuration and is loaded via a custom configuration handler. <a href="#a6af8469a7183eb319a432cefcaeed677"></a><br/></td></tr>
<tr class="separator:a6af8469a7183eb319a432cefcaeed677"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a532c36a35ae41b79ec6e5b0fbab9d748"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html#a532c36a35ae41b79ec6e5b0fbab9d748">Id</a><code> [get]</code></td></tr>
<tr class="memdesc:a532c36a35ae41b79ec6e5b0fbab9d748"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique Id value assigned to this <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html" title="Definition of a configurable set of search indexes made accessible by the LuceneServer windows servic...">DistributedSearcher</a>. Not required for any processing, simply for identification in reference. <a href="#a532c36a35ae41b79ec6e5b0fbab9d748"></a><br/></td></tr>
<tr class="separator:a532c36a35ae41b79ec6e5b0fbab9d748"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78f3df639881c2010762f72e4f7a6b3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#adf8d2dd9c2e32568510226ffe5c115b8">SearchMethod</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html#a78f3df639881c2010762f72e4f7a6b3b">SearchMethod</a><code> [get]</code></td></tr>
<tr class="memdesc:a78f3df639881c2010762f72e4f7a6b3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration value specifying the locality of the index &ndash; local or remote <a href="#a78f3df639881c2010762f72e4f7a6b3b"></a><br/></td></tr>
<tr class="separator:a78f3df639881c2010762f72e4f7a6b3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a902da084cc9349fb1b890225de00aae3"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html#a902da084cc9349fb1b890225de00aae3">Location</a><code> [get]</code></td></tr>
<tr class="memdesc:a902da084cc9349fb1b890225de00aae3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference path to the <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html" title="Definition of a configurable set of search indexes made accessible by the LuceneServer windows servic...">DistributedSearcher</a>. If SearchMethod is Local, this is a local file-system path, i.e. "c:\local\index". If SearchMethod is <a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html">Distributed</a>, this is the URI of the server-activated service type, i.e. "tcp://192.168.1.100:1089/RemoteIndex". <a href="#a902da084cc9349fb1b890225de00aae3"></a><br/></td></tr>
<tr class="separator:a902da084cc9349fb1b890225de00aae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Definition of a configurable set of search indexes made accessible by the LuceneServer windows service for a consuming application. These search indexes are defined in the configuration file of an application. The locations defined in a <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html" title="Definition of a configurable set of search indexes made accessible by the LuceneServer windows servic...">DistributedSearcher</a> match the exposed object URIs as defined in the LuceneServer service. </p>
<p>An example configuration would look like the following: <code> &lt;DistributedSearchers&gt; &lt;DistributedSearcher id="1" searchmethod="0" location="c:\localindexes\LocalIndex1"&gt; &lt;DistributedSearcher id="2" searchmethod="1" location="tcp://192.168.1.100:1089/RemoteIndex1"&gt; &lt;DistributedSearcher id="3" searchmethod="1" location="tcp://192.168.1.101:1089/RemoteIndex2"&gt; &lt;/DistributedSearchers&gt; </code> </p>
<p>Definition at line <a class="el" href="_distributed_searcher_8cs_source.html#l00042">42</a> of file <a class="el" href="_distributed_searcher_8cs_source.html">DistributedSearcher.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6af8469a7183eb319a432cefcaeed677"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Distributed.Configuration.DistributedSearcher.DistributedSearcher </td>
<td>(</td>
<td class="paramtype">XmlNode&#160;</td>
<td class="paramname"><em>xSection</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Public constructor for <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html" title="Definition of a configurable set of search indexes made accessible by the LuceneServer windows servic...">DistributedSearcher</a>. A <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html" title="Definition of a configurable set of search indexes made accessible by the LuceneServer windows servic...">DistributedSearcher</a> is defined in XML configuration and is loaded via a custom configuration handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xSection</td><td>The Xml definition in the configuration file</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_distributed_searcher_8cs_source.html#l00053">53</a> of file <a class="el" href="_distributed_searcher_8cs_source.html">DistributedSearcher.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a532c36a35ae41b79ec6e5b0fbab9d748"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Distributed.Configuration.DistributedSearcher.Id</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique Id value assigned to this <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html" title="Definition of a configurable set of search indexes made accessible by the LuceneServer windows servic...">DistributedSearcher</a>. Not required for any processing, simply for identification in reference. </p>
<p>Definition at line <a class="el" href="_distributed_searcher_8cs_source.html#l00105">105</a> of file <a class="el" href="_distributed_searcher_8cs_source.html">DistributedSearcher.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a902da084cc9349fb1b890225de00aae3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Lucene.Net.Distributed.Configuration.DistributedSearcher.Location</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reference path to the <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_distributed_searcher.html" title="Definition of a configurable set of search indexes made accessible by the LuceneServer windows servic...">DistributedSearcher</a>. If SearchMethod is Local, this is a local file-system path, i.e. "c:\local\index". If SearchMethod is <a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html">Distributed</a>, this is the URI of the server-activated service type, i.e. "tcp://192.168.1.100:1089/RemoteIndex". </p>
<p>Definition at line <a class="el" href="_distributed_searcher_8cs_source.html#l00122">122</a> of file <a class="el" href="_distributed_searcher_8cs_source.html">DistributedSearcher.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a78f3df639881c2010762f72e4f7a6b3b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#adf8d2dd9c2e32568510226ffe5c115b8">SearchMethod</a> Lucene.Net.Distributed.Configuration.DistributedSearcher.SearchMethod</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration value specifying the locality of the index &ndash; local or remote </p>
<p>Definition at line <a class="el" href="_distributed_searcher_8cs_source.html#l00113">113</a> of file <a class="el" href="_distributed_searcher_8cs_source.html">DistributedSearcher.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/DistributedSearch/Distributed/Configuration/<a class="el" href="_distributed_searcher_8cs_source.html">DistributedSearcher.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:49 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>