| <!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.Indexing.IndexSet 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 |
|  <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 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 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> |
| <!-- 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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_indexing.html">Indexing</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html">IndexSet</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Distributed.Indexing.IndexSet Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Definition of configurable search indexes managed by the LuceneUpdater windows service. |
| <a href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.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:a8c16fe0137d07398adcd7c8af830cf74"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a8c16fe0137d07398adcd7c8af830cf74">IndexSet</a> (XmlNode node)</td></tr> |
| <tr class="memdesc:a8c16fe0137d07398adcd7c8af830cf74"><td class="mdescLeft"> </td><td class="mdescRight">Public constructor for <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</a>. An <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</a> is defined in XML configuration and is loaded via a custom configuration handler. <a href="#a8c16fe0137d07398adcd7c8af830cf74"></a><br/></td></tr> |
| <tr class="separator:a8c16fe0137d07398adcd7c8af830cf74"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae1321e9962291ca5bd71003c24aac550"><td class="memItemLeft" align="right" valign="top">NameValueCollection </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#ae1321e9962291ca5bd71003c24aac550">GetDeletionCollection</a> ()</td></tr> |
| <tr class="memdesc:ae1321e9962291ca5bd71003c24aac550"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a NameValueCollection of records to first be deleted from an index. Name/Value pair combination consists of IdColumn and RecordId from each <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_document.html" title="Base class representing a record to be added to a Lucene index.">IndexDocument</a> in IndexDocuments. <a href="#ae1321e9962291ca5bd71003c24aac550"></a><br/></td></tr> |
| <tr class="separator:ae1321e9962291ca5bd71003c24aac550"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a847dd190e2f56b14536613d35bdb15a5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a847dd190e2f56b14536613d35bdb15a5">Reset</a> ()</td></tr> |
| <tr class="memdesc:a847dd190e2f56b14536613d35bdb15a5"><td class="mdescLeft"> </td><td class="mdescRight">Clears the contents of <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html">Documents</a> and IndexDocuments <a href="#a847dd190e2f56b14536613d35bdb15a5"></a><br/></td></tr> |
| <tr class="separator:a847dd190e2f56b14536613d35bdb15a5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab368cc611fc2219bf058ec4a769e1c7d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#ab368cc611fc2219bf058ec4a769e1c7d">Optimize</a> ()</td></tr> |
| <tr class="memdesc:ab368cc611fc2219bf058ec4a769e1c7d"><td class="mdescLeft"> </td><td class="mdescRight">Executes a <a class="el" href="namespace_lucene_1_1_net.html">Lucene.Net</a> optimization against the referenced index. <a href="#ab368cc611fc2219bf058ec4a769e1c7d"></a><br/></td></tr> |
| <tr class="separator:ab368cc611fc2219bf058ec4a769e1c7d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acc7a0dbb71b5fd2620721105bff10949"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#acc7a0dbb71b5fd2620721105bff10949">ContainsId</a> (int recordId)</td></tr> |
| <tr class="memdesc:acc7a0dbb71b5fd2620721105bff10949"><td class="mdescLeft"> </td><td class="mdescRight">Indicates if a given recordId exists within the configuration definition of TopId and BottomId. <a href="#acc7a0dbb71b5fd2620721105bff10949"></a><br/></td></tr> |
| <tr class="separator:acc7a0dbb71b5fd2620721105bff10949"><td class="memSeparator" colspan="2"> </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:a8629ec990bef00e64a67e4bece1e814b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a8629ec990bef00e64a67e4bece1e814b">Id</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a8629ec990bef00e64a67e4bece1e814b"><td class="mdescLeft"> </td><td class="mdescRight">Unique identifier for an <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</a> within a configuration of multiple <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</a> objects <a href="#a8629ec990bef00e64a67e4bece1e814b"></a><br/></td></tr> |
| <tr class="separator:a8629ec990bef00e64a67e4bece1e814b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aea8c89c3cfd0c6d4c5a1433a562fbf82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a2e95f18fc831d2490a6fde96d1241ebe">IndexAction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#aea8c89c3cfd0c6d4c5a1433a562fbf82">IndexAction</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aea8c89c3cfd0c6d4c5a1433a562fbf82"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration dictating the type of updates to be applied to the underlying master index <a href="#aea8c89c3cfd0c6d4c5a1433a562fbf82"></a><br/></td></tr> |
| <tr class="separator:aea8c89c3cfd0c6d4c5a1433a562fbf82"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a31377232b952be0a03bbed9fea1cc550"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a92a544cd1d2b9b8c49aac183fb347b83">AnalyzerType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a31377232b952be0a03bbed9fea1cc550">AnalyzerType</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a31377232b952be0a03bbed9fea1cc550"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration dictating the type of Analyzer to be applied to IndexDocuments in update scenarios <a href="#a31377232b952be0a03bbed9fea1cc550"></a><br/></td></tr> |
| <tr class="separator:a31377232b952be0a03bbed9fea1cc550"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aea2dee2d4f33c7b1bff4cf48c3dd28d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#aea2dee2d4f33c7b1bff4cf48c3dd28d3">Analzyer</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aea2dee2d4f33c7b1bff4cf48c3dd28d3"><td class="mdescLeft"> </td><td class="mdescRight">The Analyzer object used in application of <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_document.html" title="Base class representing a record to be added to a Lucene index.">IndexDocument</a> updates <a href="#aea2dee2d4f33c7b1bff4cf48c3dd28d3"></a><br/></td></tr> |
| <tr class="separator:aea2dee2d4f33c7b1bff4cf48c3dd28d3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a081a2dc3f4511ab75dcb06f411d8716b"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a081a2dc3f4511ab75dcb06f411d8716b">LocalPath</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a081a2dc3f4511ab75dcb06f411d8716b"><td class="mdescLeft"> </td><td class="mdescRight">Filesystem path to the master index <a href="#a081a2dc3f4511ab75dcb06f411d8716b"></a><br/></td></tr> |
| <tr class="separator:a081a2dc3f4511ab75dcb06f411d8716b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a39ebe5758fa5f185dc8eb08b8b794c50"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a39ebe5758fa5f185dc8eb08b8b794c50">IdColumn</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a39ebe5758fa5f185dc8eb08b8b794c50"><td class="mdescLeft"> </td><td class="mdescRight">String name representing the unique key for the given record in the index <a href="#a39ebe5758fa5f185dc8eb08b8b794c50"></a><br/></td></tr> |
| <tr class="separator:a39ebe5758fa5f185dc8eb08b8b794c50"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a686d36b1f3672aaa3cc7ea649e4d5765"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a686d36b1f3672aaa3cc7ea649e4d5765">BottomId</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a686d36b1f3672aaa3cc7ea649e4d5765"><td class="mdescLeft"> </td><td class="mdescRight">Minimum IdColumn value for a record in this index <a href="#a686d36b1f3672aaa3cc7ea649e4d5765"></a><br/></td></tr> |
| <tr class="separator:a686d36b1f3672aaa3cc7ea649e4d5765"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6b307884e0f3cf5f188fce8e36ad2661"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a6b307884e0f3cf5f188fce8e36ad2661">TopId</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6b307884e0f3cf5f188fce8e36ad2661"><td class="mdescLeft"> </td><td class="mdescRight">Maximum IdColumn value for a record in this index <a href="#a6b307884e0f3cf5f188fce8e36ad2661"></a><br/></td></tr> |
| <tr class="separator:a6b307884e0f3cf5f188fce8e36ad2661"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4079cba878e96dce7e91b9a8177cf3b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.html">CurrentIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a4079cba878e96dce7e91b9a8177cf3b5">CurrentIndex</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4079cba878e96dce7e91b9a8177cf3b5"><td class="mdescLeft"> </td><td class="mdescRight">CurrentIndex object associated with this <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</a>. The CurrentIndex is used in determining index settings and maintenance as well as managing physical file updates for index updates. <a href="#a4079cba878e96dce7e91b9a8177cf3b5"></a><br/></td></tr> |
| <tr class="separator:a4079cba878e96dce7e91b9a8177cf3b5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa6c674310a2a6373e4a7236610aecc54"><td class="memItemLeft" align="right" valign="top">List< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#aa6c674310a2a6373e4a7236610aecc54">FileSystemDocuments</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aa6c674310a2a6373e4a7236610aecc54"><td class="mdescLeft"> </td><td class="mdescRight">List of filesystem paths representing files for the master index <a href="#aa6c674310a2a6373e4a7236610aecc54"></a><br/></td></tr> |
| <tr class="separator:aa6c674310a2a6373e4a7236610aecc54"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7190b85ae107daafcac3fe9861edb2ba"><td class="memItemLeft" align="right" valign="top">Hashtable </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a7190b85ae107daafcac3fe9861edb2ba">IndexDocuments</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a7190b85ae107daafcac3fe9861edb2ba"><td class="mdescLeft"> </td><td class="mdescRight">Pending updates to be applied to the master index <a href="#a7190b85ae107daafcac3fe9861edb2ba"></a><br/></td></tr> |
| <tr class="separator:a7190b85ae107daafcac3fe9861edb2ba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3baf7e683fbd05e906f395687c2fa2c1"><td class="memItemLeft" align="right" valign="top">Hashtable </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html#a3baf7e683fbd05e906f395687c2fa2c1">Documents</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a3baf7e683fbd05e906f395687c2fa2c1"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the DeleteIndexDocuments from IndexDocuments <a href="#a3baf7e683fbd05e906f395687c2fa2c1"></a><br/></td></tr> |
| <tr class="separator:a3baf7e683fbd05e906f395687c2fa2c1"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Definition of configurable search indexes managed by the LuceneUpdater windows service. </p> |
| <p>An example configuration would look like the following: <code> <indexsets compoundfile="true" deltadirectory="c:\indexes\indexdocuments"> <indexSet id="1" action="1" analyzer="1"> <add key="localpath" value="c:\lucene\masterindex\index1"> <copy> <targetPath indexa="\\LuceneServer\lucene\indexA\index1" indexb="\\LuceneServer\lucene\indexA\index1"> <statusDir value="\\LuceneServer\lucene\statusfile\"> </copy> <add key="bottomid" value="1"> <add key="topid" value="1000"> <add key="idcolumn" value="pkId"> </indexSet> </indexsets> </code> </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00054">54</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a8c16fe0137d07398adcd7c8af830cf74"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Distributed.Indexing.IndexSet.IndexSet </td> |
| <td>(</td> |
| <td class="paramtype">XmlNode </td> |
| <td class="paramname"><em>node</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_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</a>. An <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</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">node</td><td>XmlNode definition for a given <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</a></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00076">76</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="acc7a0dbb71b5fd2620721105bff10949"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Distributed.Indexing.IndexSet.ContainsId </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>recordId</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Indicates if a given recordId exists within the configuration definition of TopId and BottomId. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">recordId</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00357">357</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae1321e9962291ca5bd71003c24aac550"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">NameValueCollection Lucene.Net.Distributed.Indexing.IndexSet.GetDeletionCollection </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Retrieves a NameValueCollection of records to first be deleted from an index. Name/Value pair combination consists of IdColumn and RecordId from each <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_document.html" title="Base class representing a record to be added to a Lucene index.">IndexDocument</a> in IndexDocuments. </p> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00320">320</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab368cc611fc2219bf058ec4a769e1c7d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Distributed.Indexing.IndexSet.Optimize </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Executes a <a class="el" href="namespace_lucene_1_1_net.html">Lucene.Net</a> optimization against the referenced index. </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00340">340</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a847dd190e2f56b14536613d35bdb15a5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Distributed.Indexing.IndexSet.Reset </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Clears the contents of <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html">Documents</a> and IndexDocuments </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00331">331</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a31377232b952be0a03bbed9fea1cc550"></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#a92a544cd1d2b9b8c49aac183fb347b83">AnalyzerType</a> Lucene.Net.Distributed.Indexing.IndexSet.AnalyzerType</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 dictating the type of Analyzer to be applied to IndexDocuments in update scenarios </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00225">225</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aea2dee2d4f33c7b1bff4cf48c3dd28d3"></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="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> Lucene.Net.Distributed.Indexing.IndexSet.Analzyer</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>The Analyzer object used in application of <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_document.html" title="Base class representing a record to be added to a Lucene index.">IndexDocument</a> updates </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00233">233</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a686d36b1f3672aaa3cc7ea649e4d5765"></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.Indexing.IndexSet.BottomId</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>Minimum IdColumn value for a record in this index </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00257">257</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4079cba878e96dce7e91b9a8177cf3b5"></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="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.html">CurrentIndex</a> Lucene.Net.Distributed.Indexing.IndexSet.CurrentIndex</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>CurrentIndex object associated with this <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</a>. The CurrentIndex is used in determining index settings and maintenance as well as managing physical file updates for index updates. </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00275">275</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3baf7e683fbd05e906f395687c2fa2c1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Hashtable Lucene.Net.Distributed.Indexing.IndexSet.Documents</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>Retrieves the DeleteIndexDocuments from IndexDocuments </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00299">299</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa6c674310a2a6373e4a7236610aecc54"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">List<string> Lucene.Net.Distributed.Indexing.IndexSet.FileSystemDocuments</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>List of filesystem paths representing files for the master index </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00283">283</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8629ec990bef00e64a67e4bece1e814b"></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.Indexing.IndexSet.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 identifier for an <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</a> within a configuration of multiple <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_indexing_1_1_index_set.html" title="Definition of configurable search indexes managed by the LuceneUpdater windows service.">IndexSet</a> objects </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00209">209</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a39ebe5758fa5f185dc8eb08b8b794c50"></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.Indexing.IndexSet.IdColumn</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>String name representing the unique key for the given record in the index </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00249">249</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aea8c89c3cfd0c6d4c5a1433a562fbf82"></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#a2e95f18fc831d2490a6fde96d1241ebe">IndexAction</a> Lucene.Net.Distributed.Indexing.IndexSet.IndexAction</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 dictating the type of updates to be applied to the underlying master index </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00217">217</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7190b85ae107daafcac3fe9861edb2ba"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Hashtable Lucene.Net.Distributed.Indexing.IndexSet.IndexDocuments</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>Pending updates to be applied to the master index </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00291">291</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a081a2dc3f4511ab75dcb06f411d8716b"></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.Indexing.IndexSet.LocalPath</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>Filesystem path to the master index </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00241">241</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6b307884e0f3cf5f188fce8e36ad2661"></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.Indexing.IndexSet.TopId</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>Maximum IdColumn value for a record in this index </p> |
| |
| <p>Definition at line <a class="el" href="_index_set_8cs_source.html#l00265">265</a> of file <a class="el" href="_index_set_8cs_source.html">IndexSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>contrib/DistributedSearch/Distributed/Indexing/<a class="el" href="_index_set_8cs_source.html">IndexSet.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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
