blob: 4809219ab2594dddeee95b8f1716b5bf66ea58bd [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: Package Lucene.Net.Distributed</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 class="current"><a href="namespaces.html"><span>Packages</span></a></li>
<li><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="namespaces.html"><span>Packages</span></a></li>
<li><a href="namespacemembers.html"><span>Package&#160;Functions</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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Package Lucene.Net.Distributed</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespace_lucene_1_1_net_1_1_distributed_1_1_configuration"><td class="memItemLeft" align="right" valign="top">package &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed_1_1_configuration.html">Configuration</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespace_lucene_1_1_net_1_1_distributed_1_1_indexing"><td class="memItemLeft" align="right" valign="top">package &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed_1_1_indexing.html">Indexing</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespace_lucene_1_1_net_1_1_distributed_1_1_operations"><td class="memItemLeft" align="right" valign="top">package &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed_1_1_operations.html">Operations</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespace_lucene_1_1_net_1_1_distributed_1_1_search"><td class="memItemLeft" align="right" valign="top">package &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed_1_1_search.html">Search</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:adf8d2dd9c2e32568510226ffe5c115b8"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#adf8d2dd9c2e32568510226ffe5c115b8">SearchMethod</a> { <a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#adf8d2dd9c2e32568510226ffe5c115b8a509820290d57f333403f490dde7316f4">Local</a> = 0,
<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#adf8d2dd9c2e32568510226ffe5c115b8a8c16cbebef45d87fd2b36ce69f46c526">Distributed</a> = 1,
<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#adf8d2dd9c2e32568510226ffe5c115b8aec0fc0100c4fc1ce4eea230c3dc10360">Undefined</a> = 2
}</td></tr>
<tr class="memdesc:adf8d2dd9c2e32568510226ffe5c115b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the location of a DistributedSearcher <a href="namespace_lucene_1_1_net_1_1_distributed.html#adf8d2dd9c2e32568510226ffe5c115b8">More...</a><br/></td></tr>
<tr class="separator:adf8d2dd9c2e32568510226ffe5c115b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7188ec6ea559e9311660e706d283ddef"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a7188ec6ea559e9311660e706d283ddef">FieldStorageType</a> { <a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a7188ec6ea559e9311660e706d283ddefa220f3d3750583b9db48568a0b5b9a5f1">Keyword</a> = 1,
<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a7188ec6ea559e9311660e706d283ddefa41e38141372d995609f58410e24fd6bc">UnIndexed</a> = 2,
<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a7188ec6ea559e9311660e706d283ddefae6934c57866dd963de2a3bec1cb20574">UnStored</a> = 3,
<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a7188ec6ea559e9311660e706d283ddefa9dffbf69ffba8bc38bc4e01abf4b1675">Text</a> = 4
}</td></tr>
<tr class="memdesc:a7188ec6ea559e9311660e706d283ddef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the type of Field in an IndexDocument <a href="namespace_lucene_1_1_net_1_1_distributed.html#a7188ec6ea559e9311660e706d283ddef">More...</a><br/></td></tr>
<tr class="separator:a7188ec6ea559e9311660e706d283ddef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e95f18fc831d2490a6fde96d1241ebe"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a2e95f18fc831d2490a6fde96d1241ebe">IndexAction</a> { <a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a2e95f18fc831d2490a6fde96d1241ebea1e601ea653db1c729c9ee5746730fabe">NoAction</a> = 0,
<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a2e95f18fc831d2490a6fde96d1241ebea06933067aafd48425d67bcb01bba5cb6">Update</a> = 1,
<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a2e95f18fc831d2490a6fde96d1241ebeada364eb37e143f6b2b5559aa03f5913a">Overwrite</a> = 2
}</td></tr>
<tr class="memdesc:a2e95f18fc831d2490a6fde96d1241ebe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the type of action for an IndexSet to take when applying changes to an index <a href="namespace_lucene_1_1_net_1_1_distributed.html#a2e95f18fc831d2490a6fde96d1241ebe">More...</a><br/></td></tr>
<tr class="separator:a2e95f18fc831d2490a6fde96d1241ebe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92a544cd1d2b9b8c49aac183fb347b83"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a92a544cd1d2b9b8c49aac183fb347b83">AnalyzerType</a> { <a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a92a544cd1d2b9b8c49aac183fb347b83a595822dc902fbd7ca21a43521a68dfc8">StandardAnalyzer</a> = 0,
<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a92a544cd1d2b9b8c49aac183fb347b83adb020bab78b37a21c214f3008bb92528">SimpleAnalyzer</a> = 1,
<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a92a544cd1d2b9b8c49aac183fb347b83a2442fbe8206eef4e57747bad1efdd9b6">WhitespaceAnalyzer</a> = 2,
<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a92a544cd1d2b9b8c49aac183fb347b83a96d46a46464a5b3a7448e74516335f76">StopAnalyzer</a> = 3
}</td></tr>
<tr class="memdesc:a92a544cd1d2b9b8c49aac183fb347b83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the type of Analyzer to use in creation of an IndexDocument <a href="namespace_lucene_1_1_net_1_1_distributed.html#a92a544cd1d2b9b8c49aac183fb347b83">More...</a><br/></td></tr>
<tr class="separator:a92a544cd1d2b9b8c49aac183fb347b83"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a92a544cd1d2b9b8c49aac183fb347b83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a92a544cd1d2b9b8c49aac183fb347b83">Lucene.Net.Distributed.AnalyzerType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the type of Analyzer to use in creation of an IndexDocument </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a92a544cd1d2b9b8c49aac183fb347b83a595822dc902fbd7ca21a43521a68dfc8"></a>StandardAnalyzer</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a92a544cd1d2b9b8c49aac183fb347b83adb020bab78b37a21c214f3008bb92528"></a>SimpleAnalyzer</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a92a544cd1d2b9b8c49aac183fb347b83a2442fbe8206eef4e57747bad1efdd9b6"></a>WhitespaceAnalyzer</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a92a544cd1d2b9b8c49aac183fb347b83a96d46a46464a5b3a7448e74516335f76"></a>StopAnalyzer</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="_enumerations_8cs_source.html#l00057">57</a> of file <a class="el" href="_enumerations_8cs_source.html">Enumerations.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a7188ec6ea559e9311660e706d283ddef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a7188ec6ea559e9311660e706d283ddef">Lucene.Net.Distributed.FieldStorageType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the type of Field in an IndexDocument </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a7188ec6ea559e9311660e706d283ddefa220f3d3750583b9db48568a0b5b9a5f1"></a>Keyword</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a7188ec6ea559e9311660e706d283ddefa41e38141372d995609f58410e24fd6bc"></a>UnIndexed</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a7188ec6ea559e9311660e706d283ddefae6934c57866dd963de2a3bec1cb20574"></a>UnStored</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a7188ec6ea559e9311660e706d283ddefa9dffbf69ffba8bc38bc4e01abf4b1675"></a>Text</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="_enumerations_8cs_source.html#l00036">36</a> of file <a class="el" href="_enumerations_8cs_source.html">Enumerations.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2e95f18fc831d2490a6fde96d1241ebe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a2e95f18fc831d2490a6fde96d1241ebe">Lucene.Net.Distributed.IndexAction</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the type of action for an IndexSet to take when applying changes to an index </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a2e95f18fc831d2490a6fde96d1241ebea1e601ea653db1c729c9ee5746730fabe"></a>NoAction</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a2e95f18fc831d2490a6fde96d1241ebea06933067aafd48425d67bcb01bba5cb6"></a>Update</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a2e95f18fc831d2490a6fde96d1241ebeada364eb37e143f6b2b5559aa03f5913a"></a>Overwrite</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="_enumerations_8cs_source.html#l00047">47</a> of file <a class="el" href="_enumerations_8cs_source.html">Enumerations.cs</a>.</p>
</div>
</div>
<a class="anchor" id="adf8d2dd9c2e32568510226ffe5c115b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#adf8d2dd9c2e32568510226ffe5c115b8">Lucene.Net.Distributed.SearchMethod</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the location of a DistributedSearcher </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="adf8d2dd9c2e32568510226ffe5c115b8a509820290d57f333403f490dde7316f4"></a>Local</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="adf8d2dd9c2e32568510226ffe5c115b8a8c16cbebef45d87fd2b36ce69f46c526"></a>Distributed</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="adf8d2dd9c2e32568510226ffe5c115b8aec0fc0100c4fc1ce4eea230c3dc10360"></a>Undefined</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="_enumerations_8cs_source.html#l00026">26</a> of file <a class="el" href="_enumerations_8cs_source.html">Enumerations.cs</a>.</p>
</div>
</div>
</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>