| <!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.IndexCommit 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_index_commit.html">IndexCommit</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_index_1_1_index_commit-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.IndexCommit Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Expert: represents a single commit into an index as seen 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> or <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html" title="IndexReader is an abstract class, providing an interface for accessing an index. Search of an index i...">IndexReader</a>. |
| <a href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#details">More...</a></p> |
| |
| <p>Inherited by Lucene.Net.Index.DirectoryReader.ReaderCommit, Lucene.Net.Index.IndexFileDeleter.CommitPoint, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html">Lucene.Net.Index.SegmentsGenCommit</a>, and Lucene.Net.Index.SnapshotDeletionPolicy.MyCommitPoint.</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:aff47e6a2b3b8fca0b391a4ed4a19347e"><td class="memItemLeft" align="right" valign="top">abstract void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_commit.html#aff47e6a2b3b8fca0b391a4ed4a19347e">Delete</a> ()</td></tr> |
| <tr class="memdesc:aff47e6a2b3b8fca0b391a4ed4a19347e"><td class="mdescLeft"> </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="#aff47e6a2b3b8fca0b391a4ed4a19347e"></a><br/></td></tr> |
| <tr class="separator:aff47e6a2b3b8fca0b391a4ed4a19347e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a40ed7c06cca17c2d36d05e3b411ee48e"><td class="memItemLeft" align="right" valign="top">override bool </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2c7526ce96591849aac8ac6622d7766b"><td class="memItemLeft" align="right" valign="top">override int </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"><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:ae046c896bc7ad5879150d1699508728f"><td class="memItemLeft" align="right" valign="top">abstract string </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a161f174c9717cde228682505abedec4e"><td class="memItemLeft" align="right" valign="top">abstract ICollection< string > </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"><td class="mdescLeft"> </td><td class="mdescRight">Returns all index files referenced by this commit point. <a href="#a161f174c9717cde228682505abedec4e"></a><br/></td></tr> |
| <tr class="separator:a161f174c9717cde228682505abedec4e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a202915c427e2803d1162af43dbbb705b"><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> </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a729868a8460ab4df89f8ed3e17b727b6"><td class="memItemLeft" align="right" valign="top">abstract bool </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae0d8525cbfc005f6135d547d1dbd2c49"><td class="memItemLeft" align="right" valign="top">abstract bool </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"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this commit is an optimized index. <a href="#ae0d8525cbfc005f6135d547d1dbd2c49"></a><br/></td></tr> |
| <tr class="separator:ae0d8525cbfc005f6135d547d1dbd2c49"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae8e5cb45a95f2ed9e97353169f354ce3"><td class="memItemLeft" align="right" valign="top">abstract long </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae3bb6388318efc6d9fe61f1f810c590b"><td class="memItemLeft" align="right" valign="top">abstract long </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa66b4daa16ce95792272664ac89309c5"><td class="memItemLeft" align="right" valign="top">virtual long </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0cb2d89a20a47640463c174e41d60201"><td class="memItemLeft" align="right" valign="top">abstract IDictionary< string, <br class="typebreak"/> |
| string > </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"><td class="mdescLeft"> </td><td class="mdescRight">Returns userData, previously passed to IndexWriter.Commit(System.Collections.Generic.IDictionary{string, string}) for this commit. IDictionary is String -> String. <a href="#a0cb2d89a20a47640463c174e41d60201"></a><br/></td></tr> |
| <tr class="separator:a0cb2d89a20a47640463c174e41d60201"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Expert: represents a single commit into an index as seen 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> or <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html" title="IndexReader is an abstract class, providing an interface for accessing an index. Search of an index i...">IndexReader</a>.</p> |
| <p>Changes to the content of an index are made visible only after the writer who made that change commits by writing a new segments file (<code>segments_N</code>). This point in time, when the action of writing of a new segments file to the directory is completed, is an index commit.</p> |
| <p>Each index commit point has a unique segments file associated with it. The segments file associated with a later index commit point would have a larger N.</p> |
| <p><b>WARNING</b>: This API is a new and experimental and may suddenly change. </p> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00044">44</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="aff47e6a2b3b8fca0b391a4ed4a19347e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract void Lucene.Net.Index.IndexCommit.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">pure 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>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segments_gen_commit.html#ae5ce9a998f5c7f11a45c06dbfe456a2c">Lucene.Net.Index.SegmentsGenCommit</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a40ed7c06cca17c2d36d05e3b411ee48e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override bool Lucene.Net.Index.IndexCommit.Equals </td> |
| <td>(</td> |
| <td class="paramtype">System.Object </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Two IndexCommits are equal if both their Directory and versions are equal.</p> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00076">76</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2c7526ce96591849aac8ac6622d7766b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Index.IndexCommit.GetHashCode </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00087">87</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a202915c427e2803d1162af43dbbb705b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a> Lucene.Net.Index.IndexCommit.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>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.</p> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00055">55</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a161f174c9717cde228682505abedec4e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract ICollection<string> Lucene.Net.Index.IndexCommit.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>Returns all index files referenced by this commit point.</p> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00052">52</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae3bb6388318efc6d9fe61f1f810c590b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract long Lucene.Net.Index.IndexCommit.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>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> </p> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00101">101</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a729868a8460ab4df89f8ed3e17b727b6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract bool Lucene.Net.Index.IndexCommit.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="_index_commit_8cs_source.html#l00070">70</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae0d8525cbfc005f6135d547d1dbd2c49"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract bool Lucene.Net.Index.IndexCommit.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>Returns true if this commit is an optimized index.</p> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00073">73</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae046c896bc7ad5879150d1699508728f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract string Lucene.Net.Index.IndexCommit.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 file (<code>segments_N</code>) associated with this commit point. </p> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00049">49</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa66b4daa16ce95792272664ac89309c5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual long Lucene.Net.Index.IndexCommit.Timestamp</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>Convenience method that returns the last modified time of the segments_N file corresponding to this index commit, equivalent to getDirectory().fileModified(getSegmentsFileName()). </p> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00109">109</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0cb2d89a20a47640463c174e41d60201"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract IDictionary<string, string> Lucene.Net.Index.IndexCommit.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>Returns userData, previously passed to IndexWriter.Commit(System.Collections.Generic.IDictionary{string, string}) for this commit. IDictionary is String -> String. </p> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00117">117</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae8e5cb45a95f2ed9e97353169f354ce3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract long Lucene.Net.Index.IndexCommit.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>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. </p> |
| |
| <p>Definition at line <a class="el" href="_index_commit_8cs_source.html#l00096">96</a> of file <a class="el" href="_index_commit_8cs_source.html">IndexCommit.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="_index_commit_8cs_source.html">IndexCommit.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:50 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> |
