| <!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.Index.CheckIndex.Status 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_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index.html">CheckIndex</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html">Status</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.CheckIndex.Status Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Returned from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index.html#a57737c05b66f447aaaf2e5e730be02c3" title="Returns a Status instance detailing the state of the index.">CheckIndex_Renamed_Method()</a> detailing the health and status of the index. |
| <a href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_field_norm_status.html">FieldNormStatus</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html" title="Returned from CheckIndex_Renamed_Method() detailing the health and status of the index.">Status</a> from testing field norms. <a href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_field_norm_status.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_segment_info_status.html">SegmentInfoStatus</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Holds the status of each segment in the index. See <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_infos.html" title="A collection of segmentInfo objects with methods for operating on those segments in relation to the f...">SegmentInfos</a>. <a href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_segment_info_status.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_stored_field_status.html">StoredFieldStatus</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html" title="Returned from CheckIndex_Renamed_Method() detailing the health and status of the index.">Status</a> from testing stored fields. <a href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_stored_field_status.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_term_index_status.html">TermIndexStatus</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html" title="Returned from CheckIndex_Renamed_Method() detailing the health and status of the index.">Status</a> from testing term index. <a href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_term_index_status.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_term_vector_status.html">TermVectorStatus</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html" title="Returned from CheckIndex_Renamed_Method() detailing the health and status of the index.">Status</a> from testing stored fields. <a href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_term_vector_status.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:ac94aa4eb3c5b4073fbddbab3a480149c"><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_index_1_1_check_index_1_1_status.html#ac94aa4eb3c5b4073fbddbab3a480149c">clean</a></td></tr> |
| <tr class="memdesc:ac94aa4eb3c5b4073fbddbab3a480149c"><td class="mdescLeft"> </td><td class="mdescRight">True if no problems were found with the index. <a href="#ac94aa4eb3c5b4073fbddbab3a480149c"></a><br/></td></tr> |
| <tr class="separator:ac94aa4eb3c5b4073fbddbab3a480149c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afba4564088617e3d30409d3495d730d2"><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_index_1_1_check_index_1_1_status.html#afba4564088617e3d30409d3495d730d2">missingSegments</a></td></tr> |
| <tr class="memdesc:afba4564088617e3d30409d3495d730d2"><td class="mdescLeft"> </td><td class="mdescRight">True if we were unable to locate and load the segments_N file. <a href="#afba4564088617e3d30409d3495d730d2"></a><br/></td></tr> |
| <tr class="separator:afba4564088617e3d30409d3495d730d2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a41ae1a08836bf252ab0a5f790fd3d7e3"><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_index_1_1_check_index_1_1_status.html#a41ae1a08836bf252ab0a5f790fd3d7e3">cantOpenSegments</a></td></tr> |
| <tr class="memdesc:a41ae1a08836bf252ab0a5f790fd3d7e3"><td class="mdescLeft"> </td><td class="mdescRight">True if we were unable to open the segments_N file. <a href="#a41ae1a08836bf252ab0a5f790fd3d7e3"></a><br/></td></tr> |
| <tr class="separator:a41ae1a08836bf252ab0a5f790fd3d7e3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acf7158302f00360bbb7e199d9c26ce81"><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_index_1_1_check_index_1_1_status.html#acf7158302f00360bbb7e199d9c26ce81">missingSegmentVersion</a></td></tr> |
| <tr class="memdesc:acf7158302f00360bbb7e199d9c26ce81"><td class="mdescLeft"> </td><td class="mdescRight">True if we were unable to read the version number from segments_N file. <a href="#acf7158302f00360bbb7e199d9c26ce81"></a><br/></td></tr> |
| <tr class="separator:acf7158302f00360bbb7e199d9c26ce81"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4faea00cf3e5209aea17ce2d25e8d2c8"><td class="memItemLeft" align="right" valign="top">System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html#a4faea00cf3e5209aea17ce2d25e8d2c8">segmentsFileName</a></td></tr> |
| <tr class="memdesc:a4faea00cf3e5209aea17ce2d25e8d2c8"><td class="mdescLeft"> </td><td class="mdescRight">Name of latest segments_N file in the index. <a href="#a4faea00cf3e5209aea17ce2d25e8d2c8"></a><br/></td></tr> |
| <tr class="separator:a4faea00cf3e5209aea17ce2d25e8d2c8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad44920bdfab78e76e68ca96eff002df1"><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_index_1_1_check_index_1_1_status.html#ad44920bdfab78e76e68ca96eff002df1">numSegments</a></td></tr> |
| <tr class="memdesc:ad44920bdfab78e76e68ca96eff002df1"><td class="mdescLeft"> </td><td class="mdescRight">Number of segments in the index. <a href="#ad44920bdfab78e76e68ca96eff002df1"></a><br/></td></tr> |
| <tr class="separator:ad44920bdfab78e76e68ca96eff002df1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2fc007964819581e3d2a2fe61b871b6b"><td class="memItemLeft" align="right" valign="top">System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html#a2fc007964819581e3d2a2fe61b871b6b">segmentFormat</a></td></tr> |
| <tr class="memdesc:a2fc007964819581e3d2a2fe61b871b6b"><td class="mdescLeft"> </td><td class="mdescRight">String description of the version of the index. <a href="#a2fc007964819581e3d2a2fe61b871b6b"></a><br/></td></tr> |
| <tr class="separator:a2fc007964819581e3d2a2fe61b871b6b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4726247672fc527bc7b0ffc377986c3a"><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_index_1_1_check_index_1_1_status.html#a4726247672fc527bc7b0ffc377986c3a">segmentsChecked</a> = new List<string>()</td></tr> |
| <tr class="memdesc:a4726247672fc527bc7b0ffc377986c3a"><td class="mdescLeft"> </td><td class="mdescRight">Empty unless you passed specific segments list to check as optional 3rd argument. <a href="#a4726247672fc527bc7b0ffc377986c3a"></a><br/></td></tr> |
| <tr class="separator:a4726247672fc527bc7b0ffc377986c3a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a916381ca59e53f4c215c00a5cb019b3d"><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_index_1_1_check_index_1_1_status.html#a916381ca59e53f4c215c00a5cb019b3d">toolOutOfDate</a></td></tr> |
| <tr class="memdesc:a916381ca59e53f4c215c00a5cb019b3d"><td class="mdescLeft"> </td><td class="mdescRight">True if the index was created with a newer version of <a class="el" href="namespace_lucene.html">Lucene</a> than the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index.html" title="Basic tool and API to check the health of an index and write a new segments file that removes referen...">CheckIndex</a> tool. <a href="#a916381ca59e53f4c215c00a5cb019b3d"></a><br/></td></tr> |
| <tr class="separator:a916381ca59e53f4c215c00a5cb019b3d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab36242b4358ac71a221a03501ca0019c"><td class="memItemLeft" align="right" valign="top">IList< <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_segment_info_status.html">SegmentInfoStatus</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html#ab36242b4358ac71a221a03501ca0019c">segmentInfos</a> = new List<<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_segment_info_status.html">SegmentInfoStatus</a>>()</td></tr> |
| <tr class="memdesc:ab36242b4358ac71a221a03501ca0019c"><td class="mdescLeft"> </td><td class="mdescRight">List of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_segment_info_status.html" title="Holds the status of each segment in the index. See SegmentInfos.">SegmentInfoStatus</a> instances, detailing status of each segment. <a href="#ab36242b4358ac71a221a03501ca0019c"></a><br/></td></tr> |
| <tr class="separator:ab36242b4358ac71a221a03501ca0019c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7e51d6b7d09a75bbb34b589452ffeb98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_syns2_index_8cs.html#aada057080323f6e867d8f9c189276716">Directory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html#a7e51d6b7d09a75bbb34b589452ffeb98">dir</a></td></tr> |
| <tr class="memdesc:a7e51d6b7d09a75bbb34b589452ffeb98"><td class="mdescLeft"> </td><td class="mdescRight">Directory index is in. <a href="#a7e51d6b7d09a75bbb34b589452ffeb98"></a><br/></td></tr> |
| <tr class="separator:a7e51d6b7d09a75bbb34b589452ffeb98"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a089556833eb516b77462f0362e9799a1"><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_index_1_1_check_index_1_1_status.html#a089556833eb516b77462f0362e9799a1">totLoseDocCount</a></td></tr> |
| <tr class="memdesc:a089556833eb516b77462f0362e9799a1"><td class="mdescLeft"> </td><td class="mdescRight">How many documents will be lost to bad segments. <a href="#a089556833eb516b77462f0362e9799a1"></a><br/></td></tr> |
| <tr class="separator:a089556833eb516b77462f0362e9799a1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abebef98a52de5da5d2128061ec84cb99"><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_index_1_1_check_index_1_1_status.html#abebef98a52de5da5d2128061ec84cb99">numBadSegments</a></td></tr> |
| <tr class="memdesc:abebef98a52de5da5d2128061ec84cb99"><td class="mdescLeft"> </td><td class="mdescRight">How many bad segments were found. <a href="#abebef98a52de5da5d2128061ec84cb99"></a><br/></td></tr> |
| <tr class="separator:abebef98a52de5da5d2128061ec84cb99"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa95542b845eb2690972287b3f464a9d9"><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_index_1_1_check_index_1_1_status.html#aa95542b845eb2690972287b3f464a9d9">partial</a></td></tr> |
| <tr class="memdesc:aa95542b845eb2690972287b3f464a9d9"><td class="mdescLeft"> </td><td class="mdescRight">True if we checked only specific segments (CheckIndex.CheckIndex_Renamed_Method(List{string})) was called with non-null argument). <a href="#aa95542b845eb2690972287b3f464a9d9"></a><br/></td></tr> |
| <tr class="separator:aa95542b845eb2690972287b3f464a9d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4b3fdf3f9914dbbbcde7899c4bebeb76"><td class="memItemLeft" align="right" valign="top">IDictionary< string, string > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status.html#a4b3fdf3f9914dbbbcde7899c4bebeb76">userData</a></td></tr> |
| <tr class="memdesc:a4b3fdf3f9914dbbbcde7899c4bebeb76"><td class="mdescLeft"> </td><td class="mdescRight">Holds the userData of the last commit in the index <a href="#a4b3fdf3f9914dbbbcde7899c4bebeb76"></a><br/></td></tr> |
| <tr class="separator:a4b3fdf3f9914dbbbcde7899c4bebeb76"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Returned from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index.html#a57737c05b66f447aaaf2e5e730be02c3" title="Returns a Status instance detailing the state of the index.">CheckIndex_Renamed_Method()</a> detailing the health and status of the index. </p> |
| <p><b>WARNING</b>: this API is new and experimental and is subject to suddenly change in the next release.</p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00055">55</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| </div><h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="a41ae1a08836bf252ab0a5f790fd3d7e3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.CheckIndex.Status.cantOpenSegments</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>True if we were unable to open the segments_N file. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00065">65</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac94aa4eb3c5b4073fbddbab3a480149c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.CheckIndex.Status.clean</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>True if no problems were found with the index. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00059">59</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7e51d6b7d09a75bbb34b589452ffeb98"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="_syns2_index_8cs.html#aada057080323f6e867d8f9c189276716">Directory</a> Lucene.Net.Index.CheckIndex.Status.dir</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Directory index is in. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00092">92</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="afba4564088617e3d30409d3495d730d2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.CheckIndex.Status.missingSegments</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>True if we were unable to locate and load the segments_N file. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00062">62</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acf7158302f00360bbb7e199d9c26ce81"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.CheckIndex.Status.missingSegmentVersion</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>True if we were unable to read the version number from segments_N file. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00068">68</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abebef98a52de5da5d2128061ec84cb99"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Index.CheckIndex.Status.numBadSegments</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>How many bad segments were found. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00104">104</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad44920bdfab78e76e68ca96eff002df1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Index.CheckIndex.Status.numSegments</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Number of segments in the index. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00074">74</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa95542b845eb2690972287b3f464a9d9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.CheckIndex.Status.partial</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>True if we checked only specific segments (CheckIndex.CheckIndex_Renamed_Method(List{string})) was called with non-null argument). </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00110">110</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2fc007964819581e3d2a2fe61b871b6b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System.String Lucene.Net.Index.CheckIndex.Status.segmentFormat</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>String description of the version of the index. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00077">77</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab36242b4358ac71a221a03501ca0019c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IList<<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_segment_info_status.html">SegmentInfoStatus</a>> Lucene.Net.Index.CheckIndex.Status.segmentInfos = new List<<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_segment_info_status.html">SegmentInfoStatus</a>>()</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>List of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index_1_1_status_1_1_segment_info_status.html" title="Holds the status of each segment in the index. See SegmentInfos.">SegmentInfoStatus</a> instances, detailing status of each segment. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00089">89</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4726247672fc527bc7b0ffc377986c3a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">List<string> Lucene.Net.Index.CheckIndex.Status.segmentsChecked = new List<string>()</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Empty unless you passed specific segments list to check as optional 3rd argument.</p> |
| <p><cref><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index.html#a57737c05b66f447aaaf2e5e730be02c3" title="Returns a Status instance detailing the state of the index.">CheckIndex.CheckIndex_Renamed_Method</a>(System.Collections.IList)</cref> </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00083">83</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4faea00cf3e5209aea17ce2d25e8d2c8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System.String Lucene.Net.Index.CheckIndex.Status.segmentsFileName</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Name of latest segments_N file in the index. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00071">71</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a916381ca59e53f4c215c00a5cb019b3d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Index.CheckIndex.Status.toolOutOfDate</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>True if the index was created with a newer version of <a class="el" href="namespace_lucene.html">Lucene</a> than the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_check_index.html" title="Basic tool and API to check the health of an index and write a new segments file that removes referen...">CheckIndex</a> tool. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00086">86</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a089556833eb516b77462f0362e9799a1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Index.CheckIndex.Status.totLoseDocCount</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>How many documents will be lost to bad segments. </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00101">101</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4b3fdf3f9914dbbbcde7899c4bebeb76"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IDictionary<string, string> Lucene.Net.Index.CheckIndex.Status.userData</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Holds the userData of the last commit in the index </p> |
| |
| <p>Definition at line <a class="el" href="_check_index_8cs_source.html#l00113">113</a> of file <a class="el" href="_check_index_8cs_source.html">CheckIndex.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Index/<a class="el" href="_check_index_8cs_source.html">CheckIndex.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> |
