| <!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.Store.Directory 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_store.html">Store</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_store_1_1_directory-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Store.Directory Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A <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.">Directory</a> 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. |
| <a href="class_lucene_1_1_net_1_1_store_1_1_directory.html#details">More...</a></p> |
| |
| <p>Inherits IDisposable.</p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html">Lucene.Net.Store.FileSwitchDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html">Lucene.Net.Store.FSDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_r_a_m_directory.html">Lucene.Net.Store.RAMDirectory</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:abfb7e6d495559d12b84ffb9758e1b15d"><td class="memItemLeft" align="right" valign="top">abstract System.String[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#abfb7e6d495559d12b84ffb9758e1b15d">ListAll</a> ()</td></tr> |
| <tr class="memdesc:abfb7e6d495559d12b84ffb9758e1b15d"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of strings, one for each file in the directory. <a href="#abfb7e6d495559d12b84ffb9758e1b15d"></a><br/></td></tr> |
| <tr class="separator:abfb7e6d495559d12b84ffb9758e1b15d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abff8f4b9909c5f197b18270a7ed8985c"><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_store_1_1_directory.html#abff8f4b9909c5f197b18270a7ed8985c">FileExists</a> (System.String name)</td></tr> |
| <tr class="memdesc:abff8f4b9909c5f197b18270a7ed8985c"><td class="mdescLeft"> </td><td class="mdescRight">Returns true iff a file with the given name exists. <a href="#abff8f4b9909c5f197b18270a7ed8985c"></a><br/></td></tr> |
| <tr class="separator:abff8f4b9909c5f197b18270a7ed8985c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6335b0e675938d9106c71666018eac51"><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_store_1_1_directory.html#a6335b0e675938d9106c71666018eac51">FileModified</a> (System.String name)</td></tr> |
| <tr class="memdesc:a6335b0e675938d9106c71666018eac51"><td class="mdescLeft"> </td><td class="mdescRight">Returns the time the named file was last modified. <a href="#a6335b0e675938d9106c71666018eac51"></a><br/></td></tr> |
| <tr class="separator:a6335b0e675938d9106c71666018eac51"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad374ac4d5b071ea364db40a0139b9574"><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_store_1_1_directory.html#ad374ac4d5b071ea364db40a0139b9574">TouchFile</a> (System.String name)</td></tr> |
| <tr class="memdesc:ad374ac4d5b071ea364db40a0139b9574"><td class="mdescLeft"> </td><td class="mdescRight">Set the modified time of an existing file to now. <a href="#ad374ac4d5b071ea364db40a0139b9574"></a><br/></td></tr> |
| <tr class="separator:ad374ac4d5b071ea364db40a0139b9574"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad3722fbcf237e9b2297d7834b6f09192"><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_store_1_1_directory.html#ad3722fbcf237e9b2297d7834b6f09192">DeleteFile</a> (System.String name)</td></tr> |
| <tr class="memdesc:ad3722fbcf237e9b2297d7834b6f09192"><td class="mdescLeft"> </td><td class="mdescRight">Removes an existing file in the directory. <a href="#ad3722fbcf237e9b2297d7834b6f09192"></a><br/></td></tr> |
| <tr class="separator:ad3722fbcf237e9b2297d7834b6f09192"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaf0539c5a4613457a1dbdc81a169f49f"><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_store_1_1_directory.html#aaf0539c5a4613457a1dbdc81a169f49f">FileLength</a> (System.String name)</td></tr> |
| <tr class="memdesc:aaf0539c5a4613457a1dbdc81a169f49f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of a file in the directory. <a href="#aaf0539c5a4613457a1dbdc81a169f49f"></a><br/></td></tr> |
| <tr class="separator:aaf0539c5a4613457a1dbdc81a169f49f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af44407cd2e54288502f459924efc9aac"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_index_output.html">IndexOutput</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#af44407cd2e54288502f459924efc9aac">CreateOutput</a> (System.String name)</td></tr> |
| <tr class="memdesc:af44407cd2e54288502f459924efc9aac"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new, empty file in the directory with the given name. Returns a stream writing this file. <a href="#af44407cd2e54288502f459924efc9aac"></a><br/></td></tr> |
| <tr class="separator:af44407cd2e54288502f459924efc9aac"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1b5473afa8d8883972556956d638071c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#a1b5473afa8d8883972556956d638071c">Sync</a> (System.String name)</td></tr> |
| <tr class="memdesc:a1b5473afa8d8883972556956d638071c"><td class="mdescLeft"> </td><td class="mdescRight">Ensure that any writes to this file are moved to stable storage. <a class="el" href="namespace_lucene.html">Lucene</a> uses this to properly commit changes to the index, to prevent a machine/OS crash from corrupting the index. <a href="#a1b5473afa8d8883972556956d638071c"></a><br/></td></tr> |
| <tr class="separator:a1b5473afa8d8883972556956d638071c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af08fb715df704bf7e0eb6f67e491b3c8"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_index_input.html">IndexInput</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#af08fb715df704bf7e0eb6f67e491b3c8">OpenInput</a> (System.String name)</td></tr> |
| <tr class="memdesc:af08fb715df704bf7e0eb6f67e491b3c8"><td class="mdescLeft"> </td><td class="mdescRight">Returns a stream reading an existing file. <a href="#af08fb715df704bf7e0eb6f67e491b3c8"></a><br/></td></tr> |
| <tr class="separator:af08fb715df704bf7e0eb6f67e491b3c8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a8da4004ee5216c050ed7094c3eeb6e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_index_input.html">IndexInput</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#a2a8da4004ee5216c050ed7094c3eeb6e">OpenInput</a> (System.String name, int bufferSize)</td></tr> |
| <tr class="memdesc:a2a8da4004ee5216c050ed7094c3eeb6e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a stream reading an existing file, with the specified read buffer size. The particular <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.">Directory</a> implementation may ignore the buffer size. Currently the only <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.">Directory</a> implementations that respect this parameter are <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html" title=" Base class for Directory implementations that store index files in the file system. There are currently three core subclasses:">FSDirectory</a> and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader.html" title="Class for accessing a compound stream. This class implements a directory, but is limited to only read...">Lucene.Net.Index.CompoundFileReader</a> <a href="#a2a8da4004ee5216c050ed7094c3eeb6e"></a><br/></td></tr> |
| <tr class="separator:a2a8da4004ee5216c050ed7094c3eeb6e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a28f7428b0f324cfb7dd4f615b94b0dfb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html">Lock</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#a28f7428b0f324cfb7dd4f615b94b0dfb">MakeLock</a> (System.String name)</td></tr> |
| <tr class="memdesc:a28f7428b0f324cfb7dd4f615b94b0dfb"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html" title="An interprocess mutex lock. Typical use might look like:">Lock</a>. <a href="#a28f7428b0f324cfb7dd4f615b94b0dfb"></a><br/></td></tr> |
| <tr class="separator:a28f7428b0f324cfb7dd4f615b94b0dfb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af034c6d49f075419935c0cf5b371736f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#af034c6d49f075419935c0cf5b371736f">ClearLock</a> (System.String name)</td></tr> |
| <tr class="memdesc:af034c6d49f075419935c0cf5b371736f"><td class="mdescLeft"> </td><td class="mdescRight">Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use. <a href="#af034c6d49f075419935c0cf5b371736f"></a><br/></td></tr> |
| <tr class="separator:af034c6d49f075419935c0cf5b371736f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab6db8d63d7d08a6486db6d8d0fae3efb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#ab6db8d63d7d08a6486db6d8d0fae3efb">Close</a> ()</td></tr> |
| <tr class="separator:ab6db8d63d7d08a6486db6d8d0fae3efb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aee7e78b13b835a9d411cff051e5a101f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#aee7e78b13b835a9d411cff051e5a101f">Dispose</a> ()</td></tr> |
| <tr class="memdesc:aee7e78b13b835a9d411cff051e5a101f"><td class="mdescLeft"> </td><td class="mdescRight">Closes the store. <a href="#aee7e78b13b835a9d411cff051e5a101f"></a><br/></td></tr> |
| <tr class="separator:aee7e78b13b835a9d411cff051e5a101f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a407c29121f9b5e5b40a79b33f3bdcf29"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#a407c29121f9b5e5b40a79b33f3bdcf29">SetLockFactory</a> (<a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html">LockFactory</a> lockFactory)</td></tr> |
| <tr class="memdesc:a407c29121f9b5e5b40a79b33f3bdcf29"><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a> that this <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.">Directory</a> instance should use for its locking implementation. Each * instance of <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a> should only be used for one directory (ie, do not share a single instance across multiple Directories). <a href="#a407c29121f9b5e5b40a79b33f3bdcf29"></a><br/></td></tr> |
| <tr class="separator:a407c29121f9b5e5b40a79b33f3bdcf29"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adfb37c848971f09208379edd8d022618"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#adfb37c848971f09208379edd8d022618">GetLockId</a> ()</td></tr> |
| <tr class="memdesc:adfb37c848971f09208379edd8d022618"><td class="mdescLeft"> </td><td class="mdescRight">Return a string identifier that uniquely differentiates this <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.">Directory</a> instance from other <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.">Directory</a> instances. This ID should be the same if two <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.">Directory</a> instances (even in different JVMs and/or on different machines) are considered "the same index". This is how locking "scopes" to the right index. <a href="#adfb37c848971f09208379edd8d022618"></a><br/></td></tr> |
| <tr class="separator:adfb37c848971f09208379edd8d022618"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af43436f8f012d994eeecbe80cdb566f2"><td class="memItemLeft" align="right" valign="top">override string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#af43436f8f012d994eeecbe80cdb566f2">ToString</a> ()</td></tr> |
| <tr class="separator:af43436f8f012d994eeecbe80cdb566f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adddfbc37af5bd5ac2b4133c6207a04ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#adddfbc37af5bd5ac2b4133c6207a04ab">EnsureOpen</a> ()</td></tr> |
| <tr class="memdesc:adddfbc37af5bd5ac2b4133c6207a04ab"><td class="mdescLeft"> </td><td class="mdescRight"><throws> <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_already_closed_exception.html" title="This exception is thrown when there is an attempt to access something that has already been closed...">AlreadyClosedException</a> if this <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.">Directory</a> is closed </throws> <a href="#adddfbc37af5bd5ac2b4133c6207a04ab"></a><br/></td></tr> |
| <tr class="separator:adddfbc37af5bd5ac2b4133c6207a04ab"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a048c03bc449c61d4e2805500b33d172e"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#a048c03bc449c61d4e2805500b33d172e">Copy</a> (<a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a> src, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a> dest, bool closeDirSrc)</td></tr> |
| <tr class="memdesc:a048c03bc449c61d4e2805500b33d172e"><td class="mdescLeft"> </td><td class="mdescRight">Copy contents of a directory src to a directory dest. If a file in src already exists in dest then the one in dest will be blindly overwritten. <a href="#a048c03bc449c61d4e2805500b33d172e"></a><br/></td></tr> |
| <tr class="separator:a048c03bc449c61d4e2805500b33d172e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:abbc8e1b070b3186a1b7587d415535739"><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_store_1_1_directory.html#abbc8e1b070b3186a1b7587d415535739">Dispose</a> (bool disposing)</td></tr> |
| <tr class="separator:abbc8e1b070b3186a1b7587d415535739"><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:ad11523bdc679a598c4f5e6deb3131366"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html">LockFactory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#ad11523bdc679a598c4f5e6deb3131366">LockFactory</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ad11523bdc679a598c4f5e6deb3131366"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a> that this <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.">Directory</a> instance is using for its locking implementation. Note that this may be null for <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.">Directory</a> implementations that provide their own locking implementation. <a href="#ad11523bdc679a598c4f5e6deb3131366"></a><br/></td></tr> |
| <tr class="separator:ad11523bdc679a598c4f5e6deb3131366"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad53c9747e166be96af86c391777a0793"><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_store_1_1_directory.html#ad53c9747e166be96af86c391777a0793">isOpen_ForNUnit</a><code> [get]</code></td></tr> |
| <tr class="separator:ad53c9747e166be96af86c391777a0793"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A <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.">Directory</a> 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. </p> |
| <p>Java's i/o APIs not used directly, but rather all i/o is through this API. This permits things such as: </p> |
| <ul> |
| <li> |
| implementation of RAM-based indices; </li> |
| <li> |
| implementation indices stored in a database, via JDBC; </li> |
| <li> |
| implementation of an index as a single file; </li> |
| </ul> |
| <p><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.">Directory</a> locking is implemented by an instance of <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a> , and can be changed for each <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.">Directory</a> instance using <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#a407c29121f9b5e5b40a79b33f3bdcf29" title="Set the LockFactory that this Directory instance should use for its locking implementation. Each * instance of LockFactory should only be used for one directory (ie, do not share a single instance across multiple Directories).">SetLockFactory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00042">42</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="af034c6d49f075419935c0cf5b371736f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Store.Directory.ClearLock </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></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>Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>name of the lock to be cleared. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00114">114</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab6db8d63d7d08a6486db6d8d0fae3efb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Store.Directory.Close </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="_directory_8cs_source.html#l00123">123</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a048c03bc449c61d4e2805500b33d172e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static void Lucene.Net.Store.Directory.Copy </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a> </td> |
| <td class="paramname"><em>src</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Directory</a> </td> |
| <td class="paramname"><em>dest</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>closeDirSrc</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy contents of a directory src to a directory dest. If a file in src already exists in dest then the one in dest will be blindly overwritten. </p> |
| <p><b>NOTE:</b> the source directory cannot change while this method is running. Otherwise the results are undefined and you could easily hit a FileNotFoundException.</p> |
| <p><b>NOTE:</b> this method only copies files that look like index files (ie, have extensions matching the known extensions of index files).</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">src</td><td>source directory </td></tr> |
| <tr><td class="paramname">dest</td><td>destination directory </td></tr> |
| <tr><td class="paramname">closeDirSrc</td><td>if <code>true</code>, call <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#ab6db8d63d7d08a6486db6d8d0fae3efb">Close()</a> method on source directory </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> IOException </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00201">201</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af44407cd2e54288502f459924efc9aac"></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_index_output.html">IndexOutput</a> Lucene.Net.Store.Directory.CreateOutput </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></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>Creates a new, empty file in the directory with the given name. Returns a stream writing this file. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_m_map_directory.html#ad420384aa67b5b39141ac46f754f21a9">Lucene.Net.Store.MMapDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_r_a_m_directory.html#a7177d34113b18474b18037ccde68d054">Lucene.Net.Store.RAMDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html#af6a9c0ace234b2df95a71316d768cc20">Lucene.Net.Store.FileSwitchDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_directory.html#abd10cb8ca402c6a05fedca5975920131">Lucene.Net.Store.SimpleFSDirectory</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad3722fbcf237e9b2297d7834b6f09192"></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.Store.Directory.DeleteFile </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></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>Removes an existing file in the directory. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a6d9a6a69f92227518d5e27a0363f58b0">Lucene.Net.Store.FSDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_r_a_m_directory.html#ac942b065bdc1258e801b14694c41a798">Lucene.Net.Store.RAMDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html#a8498f5443fb5ce8e82c3b352bd14222c">Lucene.Net.Store.FileSwitchDirectory</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aee7e78b13b835a9d411cff051e5a101f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Store.Directory.Dispose </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Closes the store. </p> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00129">129</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abbc8e1b070b3186a1b7587d415535739"></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.Store.Directory.Dispose </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>disposing</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a10db6d3563f9a06e5eacecb4b23c1aaa">Lucene.Net.Store.FSDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_r_a_m_directory.html#a339e6e05d9bc051982b9002ae97480b0">Lucene.Net.Store.RAMDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html#aac89b7edb51bb97029d1cc45d2b971d8">Lucene.Net.Store.FileSwitchDirectory</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="adddfbc37af5bd5ac2b4133c6207a04ab"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Store.Directory.EnsureOpen </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><throws> <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_already_closed_exception.html" title="This exception is thrown when there is an attempt to access something that has already been closed...">AlreadyClosedException</a> if this <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.">Directory</a> is closed </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00253">253</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abff8f4b9909c5f197b18270a7ed8985c"></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.Store.Directory.FileExists </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></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>Returns true iff a file with the given name exists. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#ab98439d9a00c3d8b5c737250c9f5590c">Lucene.Net.Store.FSDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html#a58992011866f17f0374806c119c7510c">Lucene.Net.Store.FileSwitchDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_r_a_m_directory.html#a1cea1a98d134b8310f349980b4b534ec">Lucene.Net.Store.RAMDirectory</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aaf0539c5a4613457a1dbdc81a169f49f"></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.Store.Directory.FileLength </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></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>Returns the length of a file in the directory. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#add4ee39c195491aeff84ee4592a84be4">Lucene.Net.Store.FSDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_r_a_m_directory.html#a0164b3905b10b1db9a83e8f69c6eeb48">Lucene.Net.Store.RAMDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html#a4441ae9ff7bbaa27c3a213d956209518">Lucene.Net.Store.FileSwitchDirectory</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6335b0e675938d9106c71666018eac51"></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.Store.Directory.FileModified </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></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>Returns the time the named file was last modified. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#aca2ba2225c3c5f65a1d00dc38005d392">Lucene.Net.Store.FSDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html#a1c3762a58ee393c5d36eaeddc89b2b41">Lucene.Net.Store.FileSwitchDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_r_a_m_directory.html#add780233b5a8e699584e30bb9a0e9c14">Lucene.Net.Store.RAMDirectory</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="adfb37c848971f09208379edd8d022618"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual string Lucene.Net.Store.Directory.GetLockId </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>Return a string identifier that uniquely differentiates this <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.">Directory</a> instance from other <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.">Directory</a> instances. This ID should be the same if two <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.">Directory</a> instances (even in different JVMs and/or on different machines) are considered "the same index". This is how locking "scopes" to the right index. </p> |
| |
| <p>Reimplemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#af05baabb53c64d7de5cff18b1ce2d7f4">Lucene.Net.Store.FSDirectory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00170">170</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abfb7e6d495559d12b84ffb9758e1b15d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract System.String [] Lucene.Net.Store.Directory.ListAll </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>Returns an array of strings, one for each file in the directory.</p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">System.IO.IOException</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#aca5d785ceced2914a18c848d2481a068">Lucene.Net.Store.FSDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html#ab78e159cc8b4ba242b6ec39da0050c91">Lucene.Net.Store.FileSwitchDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_r_a_m_directory.html#ab813e741fb4c36ec7955d1135fdc7dc5">Lucene.Net.Store.RAMDirectory</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a28f7428b0f324cfb7dd4f615b94b0dfb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html">Lock</a> Lucene.Net.Store.Directory.MakeLock </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></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>Construct a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html" title="An interprocess mutex lock. Typical use might look like:">Lock</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the lock file </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00104">104</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af08fb715df704bf7e0eb6f67e491b3c8"></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_index_input.html">IndexInput</a> Lucene.Net.Store.Directory.OpenInput </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></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>Returns a stream reading an existing file. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a471b2089fdd070fd543b1ffad3659ab6">Lucene.Net.Store.FSDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_r_a_m_directory.html#aace1d3b4bdada04dfad134dff03b8b29">Lucene.Net.Store.RAMDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html#a8d31d83ad09b874c2f0db01ba47da7a3">Lucene.Net.Store.FileSwitchDirectory</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2a8da4004ee5216c050ed7094c3eeb6e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_index_input.html">IndexInput</a> Lucene.Net.Store.Directory.OpenInput </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>bufferSize</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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>Returns a stream reading an existing file, with the specified read buffer size. The particular <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.">Directory</a> implementation may ignore the buffer size. Currently the only <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.">Directory</a> implementations that respect this parameter are <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html" title=" Base class for Directory implementations that store index files in the file system. There are currently three core subclasses:">FSDirectory</a> and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader.html" title="Class for accessing a compound stream. This class implements a directory, but is limited to only read...">Lucene.Net.Index.CompoundFileReader</a> </p> |
| |
| <p>Reimplemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_m_map_directory.html#ac56071555f9bc3b4948bd2c396952378">Lucene.Net.Store.MMapDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_directory.html#a81277add65cc14b7a64765d068837b9d">Lucene.Net.Store.SimpleFSDirectory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00096">96</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a407c29121f9b5e5b40a79b33f3bdcf29"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Store.Directory.SetLockFactory </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html">LockFactory</a> </td> |
| <td class="paramname"><em>lockFactory</em></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>Set the <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a> that this <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.">Directory</a> instance should use for its locking implementation. Each * instance of <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a> should only be used for one directory (ie, do not share a single instance across multiple Directories). </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">lockFactory</td><td>instance of <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00145">145</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1b5473afa8d8883972556956d638071c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Store.Directory.Sync </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></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>Ensure that any writes to this file are moved to stable storage. <a class="el" href="namespace_lucene.html">Lucene</a> uses this to properly commit changes to the index, to prevent a machine/OS crash from corrupting the index. </p> |
| |
| <p>Reimplemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#abd334a77552a373adef367d6707d30ba">Lucene.Net.Store.FSDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html#a0e1a2688994b71073a7db772928d400e">Lucene.Net.Store.FileSwitchDirectory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00082">82</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af43436f8f012d994eeecbe80cdb566f2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override string Lucene.Net.Store.Directory.ToString </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="_directory_8cs_source.html#l00175">175</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad374ac4d5b071ea364db40a0139b9574"></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.Store.Directory.TouchFile </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></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>Set the modified time of an existing file to now. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a7c57302da469d7b122d29d64e935effc">Lucene.Net.Store.FSDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_file_switch_directory.html#ae9ae8fcfe969c817d6028b32e4b484e6">Lucene.Net.Store.FileSwitchDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_r_a_m_directory.html#a7201010a363c98c69f95027479674557">Lucene.Net.Store.RAMDirectory</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="ad53c9747e166be96af86c391777a0793"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Store.Directory.isOpen_ForNUnit</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="_directory_8cs_source.html#l00260">260</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad11523bdc679a598c4f5e6deb3131366"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html">LockFactory</a> Lucene.Net.Store.Directory.LockFactory</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 <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a> that this <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.">Directory</a> instance is using for its locking implementation. Note that this may be null for <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.">Directory</a> implementations that provide their own locking implementation. </p> |
| |
| <p>Definition at line <a class="el" href="_directory_8cs_source.html#l00158">158</a> of file <a class="el" href="_directory_8cs_source.html">Directory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Store/<a class="el" href="_directory_8cs_source.html">Directory.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:59 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> |
