| <!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.CurrentIndex 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_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_current_index.html">CurrentIndex</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Distributed.Configuration.CurrentIndex Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Definition of current index information managed by the LuceneUpdater windows service. The <copy> node within the <indexset> node represents the information needed to load a <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.html" title="Definition of current index information managed by the LuceneUpdater windows service. The <copy> node within the <indexset> node represents the information needed to load a CurrentIndex object for a given IndexSet.">CurrentIndex</a> object for a given IndexSet. |
| <a href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.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:af03d3be537dae8b566d17f2e77a7bf55"><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_configuration_1_1_current_index.html#af03d3be537dae8b566d17f2e77a7bf55">CurrentIndex</a> (XmlNode node, string strLocalPath)</td></tr> |
| <tr class="memdesc:af03d3be537dae8b566d17f2e77a7bf55"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.html" title="Definition of current index information managed by the LuceneUpdater windows service. The <copy> node within the <indexset> node represents the information needed to load a CurrentIndex object for a given IndexSet.">CurrentIndex</a> using the XmlNode value (from IndexSetConfigurationHandler configuration) <a href="#af03d3be537dae8b566d17f2e77a7bf55"></a><br/></td></tr> |
| <tr class="separator:af03d3be537dae8b566d17f2e77a7bf55"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a322b8fe48739520e533c8c633e286f8e"><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_configuration_1_1_current_index.html#a322b8fe48739520e533c8c633e286f8e">CurrentIndex</a> (string sStatusDir)</td></tr> |
| <tr class="memdesc:a322b8fe48739520e533c8c633e286f8e"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a shell <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.html" title="Definition of current index information managed by the LuceneUpdater windows service. The <copy> node within the <indexset> node represents the information needed to load a CurrentIndex object for a given IndexSet.">CurrentIndex</a>. Use this constructor to interact with the underlying status and toggle files ONLY. <a href="#a322b8fe48739520e533c8c633e286f8e"></a><br/></td></tr> |
| <tr class="separator:a322b8fe48739520e533c8c633e286f8e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a31b383ca6b129bc6ec0707e36594bc70"><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_configuration_1_1_current_index.html#a31b383ca6b129bc6ec0707e36594bc70">Copy</a> ()</td></tr> |
| <tr class="memdesc:a31b383ca6b129bc6ec0707e36594bc70"><td class="mdescLeft"> </td><td class="mdescRight">Method that executes a filesystem copy of all directory files from a local path to the proper offline index. This method ensures no conflicts occur with the online index. <a href="#a31b383ca6b129bc6ec0707e36594bc70"></a><br/></td></tr> |
| <tr class="separator:a31b383ca6b129bc6ec0707e36594bc70"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa26951b45f6b4571c8a831dc5d4f9839"><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_configuration_1_1_current_index.html#aa26951b45f6b4571c8a831dc5d4f9839">CopyIncremental</a> ()</td></tr> |
| <tr class="memdesc:aa26951b45f6b4571c8a831dc5d4f9839"><td class="mdescLeft"> </td><td class="mdescRight">Method that executes a filesystem copy of updated or new files from a local path to the proper offline index. This method ensures no conflicts occur with the online index. <a href="#aa26951b45f6b4571c8a831dc5d4f9839"></a><br/></td></tr> |
| <tr class="separator:aa26951b45f6b4571c8a831dc5d4f9839"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a088baf6a6c1ccd85fae8fe0b8a006974"><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_configuration_1_1_current_index.html#a088baf6a6c1ccd85fae8fe0b8a006974">ProcessLocalIndexDeletes</a> (NameValueCollection nvcDeleteCollection)</td></tr> |
| <tr class="memdesc:a088baf6a6c1ccd85fae8fe0b8a006974"><td class="mdescLeft"> </td><td class="mdescRight">Takes a name/value pair collection to be used in updating an index. Deletes are necessary to ensure no duplication occurs within the index. <a href="#a088baf6a6c1ccd85fae8fe0b8a006974"></a><br/></td></tr> |
| <tr class="separator:a088baf6a6c1ccd85fae8fe0b8a006974"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6894bee6683071ec599708cffcfed42a"><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_configuration_1_1_current_index.html#a6894bee6683071ec599708cffcfed42a">ProcessLocalIndexAdditions</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> oAnalyzer, Hashtable htAddDocuments, bool bCompoundFile)</td></tr> |
| <tr class="memdesc:a6894bee6683071ec599708cffcfed42a"><td class="mdescLeft"> </td><td class="mdescRight">Executes a loop on the <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html">Documents</a> arraylist, adding each one to the index with the associated analyzer. <a href="#a6894bee6683071ec599708cffcfed42a"></a><br/></td></tr> |
| <tr class="separator:a6894bee6683071ec599708cffcfed42a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a79d662482a4ba53e98073cef9a382b58"><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_configuration_1_1_current_index.html#a79d662482a4ba53e98073cef9a382b58">IndexRefresh</a> ()</td></tr> |
| <tr class="memdesc:a79d662482a4ba53e98073cef9a382b58"><td class="mdescLeft"> </td><td class="mdescRight">Single method to be used by a searchhost to indicate an index refresh has completed. <a href="#a79d662482a4ba53e98073cef9a382b58"></a><br/></td></tr> |
| <tr class="separator:a79d662482a4ba53e98073cef9a382b58"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8d29f532b8ce8daf889fe8375dba99b8"><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_configuration_1_1_current_index.html#a8d29f532b8ce8daf889fe8375dba99b8">UpdateRefresh</a> ()</td></tr> |
| <tr class="memdesc:a8d29f532b8ce8daf889fe8375dba99b8"><td class="mdescLeft"> </td><td class="mdescRight">Single method to be used by an index updater to indicate an index update has completed. <a href="#a8d29f532b8ce8daf889fe8375dba99b8"></a><br/></td></tr> |
| <tr class="separator:a8d29f532b8ce8daf889fe8375dba99b8"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a9d05705b6953d920c7d65ccfba4da78a"><td class="memItemLeft" align="right" valign="top">static <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_configuration_1_1_current_index.html#a9d05705b6953d920c7d65ccfba4da78a">GetAnalyzer</a> (<a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a92a544cd1d2b9b8c49aac183fb347b83">AnalyzerType</a> oAnalyzerType)</td></tr> |
| <tr class="memdesc:a9d05705b6953d920c7d65ccfba4da78a"><td class="mdescLeft"> </td><td class="mdescRight">Returns an Analyzer for the given AnalyzerType <a href="#a9d05705b6953d920c7d65ccfba4da78a"></a><br/></td></tr> |
| <tr class="separator:a9d05705b6953d920c7d65ccfba4da78a"><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:a1dd52bdd3fe6306aa39e6cbf83f1abbd"><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_configuration_1_1_current_index.html#a1dd52bdd3fe6306aa39e6cbf83f1abbd">LocalPath</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1dd52bdd3fe6306aa39e6cbf83f1abbd"><td class="mdescLeft"> </td><td class="mdescRight">Filesystem path to the local source for an index; this is the path to the master index. <a href="#a1dd52bdd3fe6306aa39e6cbf83f1abbd"></a><br/></td></tr> |
| <tr class="separator:a1dd52bdd3fe6306aa39e6cbf83f1abbd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a63fbb8d51e81ac73404bf12451593527"><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_configuration_1_1_current_index.html#a63fbb8d51e81ac73404bf12451593527">StatusDirectory</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a63fbb8d51e81ac73404bf12451593527"><td class="mdescLeft"> </td><td class="mdescRight">Filesystem path to a LuceneServer's status and toggle file for a given IndexSet <a href="#a63fbb8d51e81ac73404bf12451593527"></a><br/></td></tr> |
| <tr class="separator:a63fbb8d51e81ac73404bf12451593527"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5964a7d30e93c1b20c44abdda08edd10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed_1_1_configuration.html#a4a456a34506d7cddb65f8c5979c7c08c">IndexSetting</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.html#a5964a7d30e93c1b20c44abdda08edd10">IndexSetting</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5964a7d30e93c1b20c44abdda08edd10"><td class="mdescLeft"> </td><td class="mdescRight">Indicates the current index directory (IndexSetting enum) in use (the online set) <a href="#a5964a7d30e93c1b20c44abdda08edd10"></a><br/></td></tr> |
| <tr class="separator:a5964a7d30e93c1b20c44abdda08edd10"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5304d50e350af843dae246341a3d6183"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed_1_1_configuration.html#a4a456a34506d7cddb65f8c5979c7c08c">IndexSetting</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.html#a5304d50e350af843dae246341a3d6183">IndexSettingRefresh</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5304d50e350af843dae246341a3d6183"><td class="mdescLeft"> </td><td class="mdescRight">Indicates the index directory to be used in any index searcher refresh by determining if any updates have been applied <a href="#a5304d50e350af843dae246341a3d6183"></a><br/></td></tr> |
| <tr class="separator:a5304d50e350af843dae246341a3d6183"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a08601dda4d58b17ee53821cab52852d4"><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_configuration_1_1_current_index.html#a08601dda4d58b17ee53821cab52852d4">CanCopy</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a08601dda4d58b17ee53821cab52852d4"><td class="mdescLeft"> </td><td class="mdescRight">Indicates if the current index permits updated indexes to be copied to CopyTargetPath <a href="#a08601dda4d58b17ee53821cab52852d4"></a><br/></td></tr> |
| <tr class="separator:a08601dda4d58b17ee53821cab52852d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a10f541d40e0575473ed1a332c2292120"><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_configuration_1_1_current_index.html#a10f541d40e0575473ed1a332c2292120">HasChanged</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a10f541d40e0575473ed1a332c2292120"><td class="mdescLeft"> </td><td class="mdescRight">Indicates if the current index has pending updates (in the offline directory) to be used by an index searcher in a refresh evaluation <a href="#a10f541d40e0575473ed1a332c2292120"></a><br/></td></tr> |
| <tr class="separator:a10f541d40e0575473ed1a332c2292120"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3ca1a171120d6267d6181ffe7b38a945"><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_configuration_1_1_current_index.html#a3ca1a171120d6267d6181ffe7b38a945">CopyTargetPath</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a3ca1a171120d6267d6181ffe7b38a945"><td class="mdescLeft"> </td><td class="mdescRight">The target directory path to be used when updating the offline index <a href="#a3ca1a171120d6267d6181ffe7b38a945"></a><br/></td></tr> |
| <tr class="separator:a3ca1a171120d6267d6181ffe7b38a945"><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 current index information managed by the LuceneUpdater windows service. The <copy> node within the <indexset> node represents the information needed to load a <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.html" title="Definition of current index information managed by the LuceneUpdater windows service. The <copy> node within the <indexset> node represents the information needed to load a CurrentIndex object for a given IndexSet.">CurrentIndex</a> object for a given IndexSet. </p> |
| <p>An example configuration would look like the following: <code> <indexsets ramallocation="100000" 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="_current_index_8cs_source.html#l00063">63</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="af03d3be537dae8b566d17f2e77a7bf55"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Distributed.Configuration.CurrentIndex.CurrentIndex </td> |
| <td>(</td> |
| <td class="paramtype">XmlNode </td> |
| <td class="paramname"><em>node</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>strLocalPath</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.html" title="Definition of current index information managed by the LuceneUpdater windows service. The <copy> node within the <indexset> node represents the information needed to load a CurrentIndex object for a given IndexSet.">CurrentIndex</a> using the XmlNode value (from IndexSetConfigurationHandler configuration) </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">node</td><td>XmlNode containing configuration information</td></tr> |
| <tr><td class="paramname">strLocalPath</td><td>Local filesystem path to source index</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00087">87</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a322b8fe48739520e533c8c633e286f8e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Distributed.Configuration.CurrentIndex.CurrentIndex </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>sStatusDir</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs a shell <a class="el" href="class_lucene_1_1_net_1_1_distributed_1_1_configuration_1_1_current_index.html" title="Definition of current index information managed by the LuceneUpdater windows service. The <copy> node within the <indexset> node represents the information needed to load a CurrentIndex object for a given IndexSet.">CurrentIndex</a>. Use this constructor to interact with the underlying status and toggle files ONLY. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sStatusDir</td><td>Filesystem path to the status and toggle files for an index</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00098">98</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a31b383ca6b129bc6ec0707e36594bc70"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Distributed.Configuration.CurrentIndex.Copy </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Method that executes a filesystem copy of all directory files from a local path to the proper offline index. This method ensures no conflicts occur with the online index. </p> |
| <dl class="section return"><dt>Returns</dt><dd>bool</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00207">207</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa26951b45f6b4571c8a831dc5d4f9839"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Distributed.Configuration.CurrentIndex.CopyIncremental </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Method that executes a filesystem copy of updated or new files from a local path to the proper offline index. This method ensures no conflicts occur with the online index. </p> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00234">234</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9d05705b6953d920c7d65ccfba4da78a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> Lucene.Net.Distributed.Configuration.CurrentIndex.GetAnalyzer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespace_lucene_1_1_net_1_1_distributed.html#a92a544cd1d2b9b8c49aac183fb347b83">AnalyzerType</a> </td> |
| <td class="paramname"><em>oAnalyzerType</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns an Analyzer for the given AnalyzerType </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">oAnalyzerType</td><td>Enumeration value</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Analyzer</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00590">590</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a79d662482a4ba53e98073cef9a382b58"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Distributed.Configuration.CurrentIndex.IndexRefresh </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Single method to be used by a searchhost to indicate an index refresh has completed. </p> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00301">301</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6894bee6683071ec599708cffcfed42a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Distributed.Configuration.CurrentIndex.ProcessLocalIndexAdditions </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> </td> |
| <td class="paramname"><em>oAnalyzer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Hashtable </td> |
| <td class="paramname"><em>htAddDocuments</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>bCompoundFile</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Executes a loop on the <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html">Documents</a> arraylist, adding each one to the index with the associated analyzer. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">oAnalyzer</td><td>Analyzer to be used in index document addition</td></tr> |
| <tr><td class="paramname">alAddDocuments</td><td>Arraylist of <a class="el" href="namespace_lucene.html">Lucene</a> Document objects to be inserted in the index</td></tr> |
| <tr><td class="paramname">bCompoundFile</td><td>Setting to dictate if the index should use compound format</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00283">283</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a088baf6a6c1ccd85fae8fe0b8a006974"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Distributed.Configuration.CurrentIndex.ProcessLocalIndexDeletes </td> |
| <td>(</td> |
| <td class="paramtype">NameValueCollection </td> |
| <td class="paramname"><em>nvcDeleteCollection</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Takes a name/value pair collection to be used in updating an index. Deletes are necessary to ensure no duplication occurs within the index. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">nvcDeleteCollection</td><td>Set of record IDs (with underlying field name) to be applied for index updating</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00260">260</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8d29f532b8ce8daf889fe8375dba99b8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Distributed.Configuration.CurrentIndex.UpdateRefresh </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Single method to be used by an index updater to indicate an index update has completed. </p> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00313">313</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a08601dda4d58b17ee53821cab52852d4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Distributed.Configuration.CurrentIndex.CanCopy</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>Indicates if the current index permits updated indexes to be copied to CopyTargetPath </p> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00179">179</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3ca1a171120d6267d6181ffe7b38a945"></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.CurrentIndex.CopyTargetPath</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 target directory path to be used when updating the offline index </p> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00196">196</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a10f541d40e0575473ed1a332c2292120"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Distributed.Configuration.CurrentIndex.HasChanged</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>Indicates if the current index has pending updates (in the offline directory) to be used by an index searcher in a refresh evaluation </p> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00188">188</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5964a7d30e93c1b20c44abdda08edd10"></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_1_1_configuration.html#a4a456a34506d7cddb65f8c5979c7c08c">IndexSetting</a> Lucene.Net.Distributed.Configuration.CurrentIndex.IndexSetting</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>Indicates the current index directory (IndexSetting enum) in use (the online set) </p> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00148">148</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5304d50e350af843dae246341a3d6183"></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_1_1_configuration.html#a4a456a34506d7cddb65f8c5979c7c08c">IndexSetting</a> Lucene.Net.Distributed.Configuration.CurrentIndex.IndexSettingRefresh</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>Indicates the index directory to be used in any index searcher refresh by determining if any updates have been applied </p> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00161">161</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1dd52bdd3fe6306aa39e6cbf83f1abbd"></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.CurrentIndex.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 local source for an index; this is the path to the master index. </p> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00133">133</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a63fbb8d51e81ac73404bf12451593527"></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.CurrentIndex.StatusDirectory</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 a LuceneServer's status and toggle file for a given IndexSet </p> |
| |
| <p>Definition at line <a class="el" href="_current_index_8cs_source.html#l00140">140</a> of file <a class="el" href="_current_index_8cs_source.html">CurrentIndex.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="_current_index_8cs_source.html">CurrentIndex.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> |
