blob: 1ccec30685c31cc9c9ee373a79681e5d7f788d92 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Index.SegmentsGenCommit Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html">SegmentsGenCommit</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.SegmentsGenCommit Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class that will force an index writer to open an index based on the generation in the segments.gen file as opposed to the highest generation found in a directory listing.
<a href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html">Lucene.Net.Index.IndexCommit</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:aecbdba7b7ea0572e0cda412b280931d1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#aecbdba7b7ea0572e0cda412b280931d1">SegmentsGenCommit</a> (<a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a> d)</td></tr>
<tr class="memdesc:aecbdba7b7ea0572e0cda412b280931d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ctor. <a href="#aecbdba7b7ea0572e0cda412b280931d1"></a><br/></td></tr>
<tr class="separator:aecbdba7b7ea0572e0cda412b280931d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5ce9a998f5c7f11a45c06dbfe456a2c"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#ae5ce9a998f5c7f11a45c06dbfe456a2c">Delete</a> ()</td></tr>
<tr class="memdesc:ae5ce9a998f5c7f11a45c06dbfe456a2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete this commit point. This only applies when using the commit point in the context of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html" title="An IndexWriter creates and maintains an index. The create argument to the constructor determines whet...">IndexWriter</a>'s <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a>. Upon calling this, the writer is notified that this commit point should be deleted. Decision that a commit-point should be deleted is taken by the <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a> in effect and therefore this should only be called by its IndexDeletionPolicy.OnInit{T}(IList{T}) or IndexDeletionPolicy.OnCommit{T}(IList{T}) methods. <a href="#ae5ce9a998f5c7f11a45c06dbfe456a2c"></a><br/></td></tr>
<tr class="separator:ae5ce9a998f5c7f11a45c06dbfe456a2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_index_1_1_index_commit')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html">Lucene.Net.Index.IndexCommit</a></td></tr>
<tr class="memitem:a40ed7c06cca17c2d36d05e3b411ee48e inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#a40ed7c06cca17c2d36d05e3b411ee48e">Equals</a> (System.Object other)</td></tr>
<tr class="memdesc:a40ed7c06cca17c2d36d05e3b411ee48e inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="mdescLeft">&#160;</td><td class="mdescRight">Two IndexCommits are equal if both their Directory and versions are equal. <a href="#a40ed7c06cca17c2d36d05e3b411ee48e"></a><br/></td></tr>
<tr class="separator:a40ed7c06cca17c2d36d05e3b411ee48e inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c7526ce96591849aac8ac6622d7766b inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#a2c7526ce96591849aac8ac6622d7766b">GetHashCode</a> ()</td></tr>
<tr class="separator:a2c7526ce96591849aac8ac6622d7766b inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a9f00ed013c9c4cf099a961c2f1cb235d"><td class="memItemLeft" align="right" valign="top">override string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#a9f00ed013c9c4cf099a961c2f1cb235d">SegmentsFileName</a><code> [get]</code></td></tr>
<tr class="memdesc:a9f00ed013c9c4cf099a961c2f1cb235d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the segments_n file for the generation found in the segments.gen file. <a href="#a9f00ed013c9c4cf099a961c2f1cb235d"></a><br/></td></tr>
<tr class="separator:a9f00ed013c9c4cf099a961c2f1cb235d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a267eefe1303248d3358e0a286af3a5de"><td class="memItemLeft" align="right" valign="top">override long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#a267eefe1303248d3358e0a286af3a5de">Generation</a><code> [get]</code></td></tr>
<tr class="separator:a267eefe1303248d3358e0a286af3a5de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c63996a141e9e12c7413a1699f59811"><td class="memItemLeft" align="right" valign="top">override ICollection&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#a6c63996a141e9e12c7413a1699f59811">FileNames</a><code> [get]</code></td></tr>
<tr class="separator:a6c63996a141e9e12c7413a1699f59811"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b68f7389abfd6f145525031917166f2"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#a1b68f7389abfd6f145525031917166f2">Directory</a><code> [get]</code></td></tr>
<tr class="separator:a1b68f7389abfd6f145525031917166f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4a101dc3bf853d66210817a46848881"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#ac4a101dc3bf853d66210817a46848881">IsDeleted</a><code> [get]</code></td></tr>
<tr class="separator:ac4a101dc3bf853d66210817a46848881"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47ea55a94782018e4c8d21c7f5de0c8e"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#a47ea55a94782018e4c8d21c7f5de0c8e">IsOptimized</a><code> [get]</code></td></tr>
<tr class="separator:a47ea55a94782018e4c8d21c7f5de0c8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69b3b2286a968c75a1f8aee5c1c65d81"><td class="memItemLeft" align="right" valign="top">override long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#a69b3b2286a968c75a1f8aee5c1c65d81">Version</a><code> [get]</code></td></tr>
<tr class="separator:a69b3b2286a968c75a1f8aee5c1c65d81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2db745378de1e4331404249d65889aaf"><td class="memItemLeft" align="right" valign="top">override IDictionary&lt; string, <br class="typebreak"/>
string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#a2db745378de1e4331404249d65889aaf">UserData</a><code> [get]</code></td></tr>
<tr class="separator:a2db745378de1e4331404249d65889aaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_index_1_1_index_commit')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html">Lucene.Net.Index.IndexCommit</a></td></tr>
<tr class="memitem:ae046c896bc7ad5879150d1699508728f inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">abstract string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#ae046c896bc7ad5879150d1699508728f">SegmentsFileName</a><code> [get]</code></td></tr>
<tr class="memdesc:ae046c896bc7ad5879150d1699508728f inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the segments file (<code>segments_N</code>) associated with this commit point. <a href="#ae046c896bc7ad5879150d1699508728f"></a><br/></td></tr>
<tr class="separator:ae046c896bc7ad5879150d1699508728f inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a161f174c9717cde228682505abedec4e inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">abstract ICollection&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#a161f174c9717cde228682505abedec4e">FileNames</a><code> [get]</code></td></tr>
<tr class="memdesc:a161f174c9717cde228682505abedec4e inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns all index files referenced by this commit point. <a href="#a161f174c9717cde228682505abedec4e"></a><br/></td></tr>
<tr class="separator:a161f174c9717cde228682505abedec4e inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a202915c427e2803d1162af43dbbb705b inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#a202915c427e2803d1162af43dbbb705b">Directory</a><code> [get]</code></td></tr>
<tr class="memdesc:a202915c427e2803d1162af43dbbb705b inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html" title="A Directory is a flat list of files. Files may be written once, when they are created. Once a file is created it may only be opened for read, or deleted. Random access is permitted both when reading and writing.">Store.Directory</a> for the index. <a href="#a202915c427e2803d1162af43dbbb705b"></a><br/></td></tr>
<tr class="separator:a202915c427e2803d1162af43dbbb705b inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a729868a8460ab4df89f8ed3e17b727b6 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">abstract bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#a729868a8460ab4df89f8ed3e17b727b6">IsDeleted</a><code> [get]</code></td></tr>
<tr class="separator:a729868a8460ab4df89f8ed3e17b727b6 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0d8525cbfc005f6135d547d1dbd2c49 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">abstract bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#ae0d8525cbfc005f6135d547d1dbd2c49">IsOptimized</a><code> [get]</code></td></tr>
<tr class="memdesc:ae0d8525cbfc005f6135d547d1dbd2c49 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this commit is an optimized index. <a href="#ae0d8525cbfc005f6135d547d1dbd2c49"></a><br/></td></tr>
<tr class="separator:ae0d8525cbfc005f6135d547d1dbd2c49 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8e5cb45a95f2ed9e97353169f354ce3 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">abstract long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#ae8e5cb45a95f2ed9e97353169f354ce3">Version</a><code> [get]</code></td></tr>
<tr class="memdesc:ae8e5cb45a95f2ed9e97353169f354ce3 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the version for this <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html" title="Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader...">IndexCommit</a>. This is the same value that <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html#aad20c89b2d918432b2083d6db38b6f99" title="Version number when this IndexReader was opened. Not implemented in the IndexReader base class...">IndexReader.Version</a> would return if it were opened on this commit. <a href="#ae8e5cb45a95f2ed9e97353169f354ce3"></a><br/></td></tr>
<tr class="separator:ae8e5cb45a95f2ed9e97353169f354ce3 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3bb6388318efc6d9fe61f1f810c590b inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">abstract long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#ae3bb6388318efc6d9fe61f1f810c590b">Generation</a><code> [get]</code></td></tr>
<tr class="memdesc:ae3bb6388318efc6d9fe61f1f810c590b inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the generation (the _N in segments_N) for this <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html" title="Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader...">IndexCommit</a> <a href="#ae3bb6388318efc6d9fe61f1f810c590b"></a><br/></td></tr>
<tr class="separator:ae3bb6388318efc6d9fe61f1f810c590b inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa66b4daa16ce95792272664ac89309c5 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">virtual long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#aa66b4daa16ce95792272664ac89309c5">Timestamp</a><code> [get]</code></td></tr>
<tr class="memdesc:aa66b4daa16ce95792272664ac89309c5 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience method that returns the last modified time of the segments_N file corresponding to this index commit, equivalent to getDirectory().fileModified(getSegmentsFileName()). <a href="#aa66b4daa16ce95792272664ac89309c5"></a><br/></td></tr>
<tr class="separator:aa66b4daa16ce95792272664ac89309c5 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cb2d89a20a47640463c174e41d60201 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memItemLeft" align="right" valign="top">abstract IDictionary&lt; string, <br class="typebreak"/>
string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#a0cb2d89a20a47640463c174e41d60201">UserData</a><code> [get]</code></td></tr>
<tr class="memdesc:a0cb2d89a20a47640463c174e41d60201 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns userData, previously passed to IndexWriter.Commit(System.Collections.Generic.IDictionary{string, string}) for this commit. IDictionary is String -&gt; String. <a href="#a0cb2d89a20a47640463c174e41d60201"></a><br/></td></tr>
<tr class="separator:a0cb2d89a20a47640463c174e41d60201 inherit properties_class_lucene_1_1_net_1_1_index_1_1_index_commit"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class that will force an index writer to open an index based on the generation in the segments.gen file as opposed to the highest generation found in a directory listing. </p>
<p>A use case for using this <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html" title="Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader...">IndexCommit</a> when opening an <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html" title="An IndexWriter creates and maintains an index. The create argument to the constructor determines whet...">IndexWriter</a> would be if index snapshots (source) are being copied over an existing index (target) and the source now has a lower generation than the target due to initiating a rebuild of the index. </p>
<p>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00037">37</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aecbdba7b7ea0572e0cda412b280931d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Index.SegmentsGenCommit.SegmentsGenCommit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a>&#160;</td>
<td class="paramname"><em>d</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ctor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">d</td><td>The index directory.</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00053">53</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae5ce9a998f5c7f11a45c06dbfe456a2c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Index.SegmentsGenCommit.Delete </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete this commit point. This only applies when using the commit point in the context of <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html" title="An IndexWriter creates and maintains an index. The create argument to the constructor determines whet...">IndexWriter</a>'s <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a>. Upon calling this, the writer is notified that this commit point should be deleted. Decision that a commit-point should be deleted is taken by the <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_index_deletion_policy.html" title="Expert: policy for deletion of stale index commits.">IndexDeletionPolicy</a> in effect and therefore this should only be called by its IndexDeletionPolicy.OnInit{T}(IList{T}) or IndexDeletionPolicy.OnCommit{T}(IList{T}) methods. </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#aff47e6a2b3b8fca0b391a4ed4a19347e">Lucene.Net.Index.IndexCommit</a>.</p>
<p>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00128">128</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a1b68f7389abfd6f145525031917166f2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a> Lucene.Net.Index.SegmentsGenCommit.Directory</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>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00089">89</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6c63996a141e9e12c7413a1699f59811"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override ICollection&lt;string&gt; Lucene.Net.Index.SegmentsGenCommit.FileNames</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>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00081">81</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a267eefe1303248d3358e0a286af3a5de"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override long Lucene.Net.Index.SegmentsGenCommit.Generation</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>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00073">73</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ac4a101dc3bf853d66210817a46848881"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Index.SegmentsGenCommit.IsDeleted</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>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00134">134</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a47ea55a94782018e4c8d21c7f5de0c8e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Index.SegmentsGenCommit.IsOptimized</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>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00142">142</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a9f00ed013c9c4cf099a961c2f1cb235d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override string Lucene.Net.Index.SegmentsGenCommit.SegmentsFileName</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>Get the segments_n file for the generation found in the segments.gen file. </p>
<dl class="section return"><dt>Returns</dt><dd>The segments_n file to use.</dd></dl>
<p>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00065">65</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2db745378de1e4331404249d65889aaf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override IDictionary&lt;string, string&gt; Lucene.Net.Index.SegmentsGenCommit.UserData</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>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00155">155</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a69b3b2286a968c75a1f8aee5c1c65d81"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override long Lucene.Net.Index.SegmentsGenCommit.Version</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>Definition at line <a class="el" href="_segments_gen_commit_8cs_source.html#l00147">147</a> of file <a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Core/Index/<a class="el" href="_segments_gen_commit_8cs_source.html">SegmentsGenCommit.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:49 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>