| <!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.FSDirectory 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_f_s_directory.html">FSDirectory</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="#pub-static-attribs">Static Public Attributes</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_f_s_directory-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Store.FSDirectory Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="anchor" id="subclasses"></a> Base class 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 store index files in the file system. There are currently three core subclasses: |
| <a href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_m_map_directory.html">Lucene.Net.Store.MMapDirectory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_n_i_o_f_s_directory.html">Lucene.Net.Store.NIOFSDirectory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_directory.html">Lucene.Net.Store.SimpleFSDirectory</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:aca5d785ceced2914a18c848d2481a068"><td class="memItemLeft" align="right" valign="top">override System.String[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#aca5d785ceced2914a18c848d2481a068">ListAll</a> ()</td></tr> |
| <tr class="memdesc:aca5d785ceced2914a18c848d2481a068"><td class="mdescLeft"> </td><td class="mdescRight">Lists all files (not subdirectories) in the directory. <a href="#aca5d785ceced2914a18c848d2481a068"></a><br/></td></tr> |
| <tr class="separator:aca5d785ceced2914a18c848d2481a068"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab98439d9a00c3d8b5c737250c9f5590c"><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_store_1_1_f_s_directory.html#ab98439d9a00c3d8b5c737250c9f5590c">FileExists</a> (System.String name)</td></tr> |
| <tr class="memdesc:ab98439d9a00c3d8b5c737250c9f5590c"><td class="mdescLeft"> </td><td class="mdescRight">Returns true iff a file with the given name exists. <a href="#ab98439d9a00c3d8b5c737250c9f5590c"></a><br/></td></tr> |
| <tr class="separator:ab98439d9a00c3d8b5c737250c9f5590c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aca2ba2225c3c5f65a1d00dc38005d392"><td class="memItemLeft" align="right" valign="top">override long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#aca2ba2225c3c5f65a1d00dc38005d392">FileModified</a> (System.String name)</td></tr> |
| <tr class="memdesc:aca2ba2225c3c5f65a1d00dc38005d392"><td class="mdescLeft"> </td><td class="mdescRight">Returns the time the named file was last modified. <a href="#aca2ba2225c3c5f65a1d00dc38005d392"></a><br/></td></tr> |
| <tr class="separator:aca2ba2225c3c5f65a1d00dc38005d392"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7c57302da469d7b122d29d64e935effc"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a7c57302da469d7b122d29d64e935effc">TouchFile</a> (System.String name)</td></tr> |
| <tr class="memdesc:a7c57302da469d7b122d29d64e935effc"><td class="mdescLeft"> </td><td class="mdescRight">Set the modified time of an existing file to now. <a href="#a7c57302da469d7b122d29d64e935effc"></a><br/></td></tr> |
| <tr class="separator:a7c57302da469d7b122d29d64e935effc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:add4ee39c195491aeff84ee4592a84be4"><td class="memItemLeft" align="right" valign="top">override long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#add4ee39c195491aeff84ee4592a84be4">FileLength</a> (System.String name)</td></tr> |
| <tr class="memdesc:add4ee39c195491aeff84ee4592a84be4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length in bytes of a file in the directory. <a href="#add4ee39c195491aeff84ee4592a84be4"></a><br/></td></tr> |
| <tr class="separator:add4ee39c195491aeff84ee4592a84be4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6d9a6a69f92227518d5e27a0363f58b0"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a6d9a6a69f92227518d5e27a0363f58b0">DeleteFile</a> (System.String name)</td></tr> |
| <tr class="memdesc:a6d9a6a69f92227518d5e27a0363f58b0"><td class="mdescLeft"> </td><td class="mdescRight">Removes an existing file in the directory. <a href="#a6d9a6a69f92227518d5e27a0363f58b0"></a><br/></td></tr> |
| <tr class="separator:a6d9a6a69f92227518d5e27a0363f58b0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abd334a77552a373adef367d6707d30ba"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#abd334a77552a373adef367d6707d30ba">Sync</a> (System.String name)</td></tr> |
| <tr class="memdesc:abd334a77552a373adef367d6707d30ba"><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="#abd334a77552a373adef367d6707d30ba"></a><br/></td></tr> |
| <tr class="separator:abd334a77552a373adef367d6707d30ba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a471b2089fdd070fd543b1ffad3659ab6"><td class="memItemLeft" align="right" valign="top">override <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_f_s_directory.html#a471b2089fdd070fd543b1ffad3659ab6">OpenInput</a> (System.String name)</td></tr> |
| <tr class="memdesc:a471b2089fdd070fd543b1ffad3659ab6"><td class="mdescLeft"> </td><td class="mdescRight">Returns a stream reading an existing file. <a href="#a471b2089fdd070fd543b1ffad3659ab6"></a><br/></td></tr> |
| <tr class="separator:a471b2089fdd070fd543b1ffad3659ab6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af05baabb53c64d7de5cff18b1ce2d7f4"><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_f_s_directory.html#af05baabb53c64d7de5cff18b1ce2d7f4">GetLockId</a> ()</td></tr> |
| <tr class="memdesc:af05baabb53c64d7de5cff18b1ce2d7f4"><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="#af05baabb53c64d7de5cff18b1ce2d7f4"></a><br/></td></tr> |
| <tr class="separator:af05baabb53c64d7de5cff18b1ce2d7f4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e632c5890208be7253c513430483271"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a1e632c5890208be7253c513430483271">ToString</a> ()</td></tr> |
| <tr class="memdesc:a1e632c5890208be7253c513430483271"><td class="mdescLeft"> </td><td class="mdescRight">For debug output. <a href="#a1e632c5890208be7253c513430483271"></a><br/></td></tr> |
| <tr class="separator:a1e632c5890208be7253c513430483271"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Lucene.Net.Store.Directory</a></td></tr> |
| <tr class="memitem:af44407cd2e54288502f459924efc9aac inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a8da4004ee5216c050ed7094c3eeb6e inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a28f7428b0f324cfb7dd4f615b94b0dfb inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af034c6d49f075419935c0cf5b371736f inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab6db8d63d7d08a6486db6d8d0fae3efb inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aee7e78b13b835a9d411cff051e5a101f inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="mdescLeft"> </td><td class="mdescRight">Closes the store. <a href="#aee7e78b13b835a9d411cff051e5a101f"></a><br/></td></tr> |
| <tr class="separator:aee7e78b13b835a9d411cff051e5a101f inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a407c29121f9b5e5b40a79b33f3bdcf29 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af43436f8f012d994eeecbe80cdb566f2 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adddfbc37af5bd5ac2b4133c6207a04ab inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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:a33ea2927779ca535c4cb90ea0dc76cfa"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html">FSDirectory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a33ea2927779ca535c4cb90ea0dc76cfa">Open</a> (string path)</td></tr> |
| <tr class="memdesc:a33ea2927779ca535c4cb90ea0dc76cfa"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <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> instance, trying to pick the best implementation given the current environment. The directory returned uses the <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock_factory.html" title="Implements LockFactory using native OS file locks. Note that because this LockFactory relies on java...">NativeFSLockFactory</a>. <a href="#a33ea2927779ca535c4cb90ea0dc76cfa"></a><br/></td></tr> |
| <tr class="separator:a33ea2927779ca535c4cb90ea0dc76cfa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4d1e2d61b9d1ab690e6714b05026d9de"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html">FSDirectory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a4d1e2d61b9d1ab690e6714b05026d9de">Open</a> (System.IO.DirectoryInfo path)</td></tr> |
| <tr class="memdesc:a4d1e2d61b9d1ab690e6714b05026d9de"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <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> instance, trying to pick the best implementation given the current environment. The directory returned uses the <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock_factory.html" title="Implements LockFactory using native OS file locks. Note that because this LockFactory relies on java...">NativeFSLockFactory</a>. <a href="#a4d1e2d61b9d1ab690e6714b05026d9de"></a><br/></td></tr> |
| <tr class="separator:a4d1e2d61b9d1ab690e6714b05026d9de"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae69df4a802e0f14d19428a5591c00d9f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html">FSDirectory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#ae69df4a802e0f14d19428a5591c00d9f">Open</a> (System.IO.DirectoryInfo path, <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:ae69df4a802e0f14d19428a5591c00d9f"><td class="mdescLeft"> </td><td class="mdescRight">Just like Open(System.IO.DirectoryInfo), but allows you to also specify a custom <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>. <a href="#ae69df4a802e0f14d19428a5591c00d9f"></a><br/></td></tr> |
| <tr class="separator:ae69df4a802e0f14d19428a5591c00d9f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e5a5dfe5f2b8038044dcc3f20f7fa81"><td class="memItemLeft" align="right" valign="top">static System.String[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a4e5a5dfe5f2b8038044dcc3f20f7fa81">ListAll</a> (System.IO.DirectoryInfo dir)</td></tr> |
| <tr class="memdesc:a4e5a5dfe5f2b8038044dcc3f20f7fa81"><td class="mdescLeft"> </td><td class="mdescRight">Lists all files (not subdirectories) in the directory. This method never returns null (throws System.IO.IOException instead). <a href="#a4e5a5dfe5f2b8038044dcc3f20f7fa81"></a><br/></td></tr> |
| <tr class="separator:a4e5a5dfe5f2b8038044dcc3f20f7fa81"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6c00a49d9b26eadc0a3849f206462e97"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a6c00a49d9b26eadc0a3849f206462e97">FileModified</a> (System.IO.FileInfo directory, System.String name)</td></tr> |
| <tr class="memdesc:a6c00a49d9b26eadc0a3849f206462e97"><td class="mdescLeft"> </td><td class="mdescRight">Returns the time the named file was last modified. <a href="#a6c00a49d9b26eadc0a3849f206462e97"></a><br/></td></tr> |
| <tr class="separator:a6c00a49d9b26eadc0a3849f206462e97"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_static_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_lucene_1_1_net_1_1_store_1_1_directory')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Lucene.Net.Store.Directory</a></td></tr> |
| <tr class="memitem:a048c03bc449c61d4e2805500b33d172e inherit pub_static_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_static_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit pub_static_methods_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:acf0169542a81c156510161d16aaf355d"><td class="memItemLeft" align="right" valign="top">static readonly int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#acf0169542a81c156510161d16aaf355d">DEFAULT_READ_CHUNK_SIZE</a> = Constants.JRE_IS_64BIT ? int.MaxValue: 100 * 1024 * 1024</td></tr> |
| <tr class="memdesc:acf0169542a81c156510161d16aaf355d"><td class="mdescLeft"> </td><td class="mdescRight">Default read chunk size. This is a conditional default: on 32bit JVMs, it defaults to 100 MB. On 64bit JVMs, it's <code>Integer.MAX_VALUE</code>. <a href="#acf0169542a81c156510161d16aaf355d"></a><br/></td></tr> |
| <tr class="separator:acf0169542a81c156510161d16aaf355d"><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:a10db6d3563f9a06e5eacecb4b23c1aaa"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a10db6d3563f9a06e5eacecb4b23c1aaa">Dispose</a> (bool disposing)</td></tr> |
| <tr class="separator:a10db6d3563f9a06e5eacecb4b23c1aaa"><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:aa3d77002a85376ccd723d5cc0af8bdd6"><td class="memItemLeft" align="right" valign="top">virtual DirectoryInfo </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#aa3d77002a85376ccd723d5cc0af8bdd6">Directory</a><code> [get]</code></td></tr> |
| <tr class="separator:aa3d77002a85376ccd723d5cc0af8bdd6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a15f6b09d7e61e94574f16a7f1af47683"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a15f6b09d7e61e94574f16a7f1af47683">ReadChunkSize</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a15f6b09d7e61e94574f16a7f1af47683"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of bytes to read at once from the underlying file during <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_index_input.html#a428913bea51c264523f8c6cecba321e3" title="Reads a specified number of bytes into an array at the specified offset.">IndexInput.ReadBytes(byte[],int,int)</a>. <a href="#a15f6b09d7e61e94574f16a7f1af47683"></a><br/></td></tr> |
| <tr class="separator:a15f6b09d7e61e94574f16a7f1af47683"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_class_lucene_1_1_net_1_1_store_1_1_directory"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_store_1_1_directory')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html">Lucene.Net.Store.Directory</a></td></tr> |
| <tr class="memitem:ad11523bdc679a598c4f5e6deb3131366 inherit properties_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit properties_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit properties_class_lucene_1_1_net_1_1_store_1_1_directory"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad53c9747e166be96af86c391777a0793 inherit properties_class_lucene_1_1_net_1_1_store_1_1_directory"><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 inherit properties_class_lucene_1_1_net_1_1_store_1_1_directory"><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 class="anchor" id="subclasses"></a> Base class 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 store index files in the file system. There are currently three core subclasses: </p> |
| <ul> |
| <li> |
| <p class="startli"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_directory.html" title="A straightforward implementation of FSDirectory using java.io.RandomAccessFile. However, this class has poor concurrent performance (multiple threads will bottleneck) as it synchronizes when multiple threads read from the same file. It's usually better to use NIOFSDirectory or MMapDirectory instead. ">SimpleFSDirectory</a> is a straightforward implementation using java.io.RandomAccessFile. However, it has poor concurrent performance (multiple threads will bottleneck) as it synchronizes when multiple threads read from the same file.</p> |
| <p class="endli"></p> |
| </li> |
| <li> |
| <p class="startli"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_n_i_o_f_s_directory.html" title="Not implemented. Waiting for volunteers. ">NIOFSDirectory</a> uses java.nio's FileChannel's positional io when reading to avoid synchronization when reading from the same file. Unfortunately, due to a Windows-only <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6265734">Sun JRE bug</a> this is a poor choice for Windows, but on all other platforms this is the preferred choice. Applications using System.Threading.Thread.Interrupt() or <code>Future::cancel(boolean)</code> (on Java 1.5) should use <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_directory.html" title="A straightforward implementation of FSDirectory using java.io.RandomAccessFile. However, this class has poor concurrent performance (multiple threads will bottleneck) as it synchronizes when multiple threads read from the same file. It's usually better to use NIOFSDirectory or MMapDirectory instead. ">SimpleFSDirectory</a> instead. See <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_n_i_o_f_s_directory.html" title="Not implemented. Waiting for volunteers. ">NIOFSDirectory</a> java doc for details.</p> |
| <p class="endli"></p> |
| </li> |
| <li> |
| <p class="startli"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_m_map_directory.html" title="File-based Directory implementation that uses mmap for reading, and SimpleFSDirectory.SimpleFSIndexOutput for writing.">MMapDirectory</a> uses memory-mapped IO when reading. This is a good choice if you have plenty of virtual memory relative to your index size, eg if you are running on a 64 bit JRE, or you are running on a 32 bit JRE but your index sizes are small enough to fit into the virtual memory space. Java has currently the limitation of not being able to unmap files from user code. The files are unmapped, when GC releases the byte buffers. Due to <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4724038">this bug</a> in Sun's JRE, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_m_map_directory.html" title="File-based Directory implementation that uses mmap for reading, and SimpleFSDirectory.SimpleFSIndexOutput for writing.">MMapDirectory</a>'s <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_index_input.html#a574f688ef9a010b1d8d1ba8c37926ce7">IndexInput.Close</a> is unable to close the underlying OS file handle. Only when GC finally collects the underlying objects, which could be quite some time later, will the file handle be closed. This will consume additional transient disk usage: on Windows, attempts to delete or overwrite the files will result in an exception; on other platforms, which typically have a "delete on last close" semantics, while such operations will succeed, the bytes are still consuming space on disk. For many applications this limitation is not a problem (e.g. if you have plenty of disk space, and you don't rely on overwriting files on Windows) but it's still an important limitation to be aware of. This class supplies a (possibly dangerous) workaround mentioned in the bug report, which may fail on non-Sun JVMs.</p> |
| <p class="endli">Applications using System.Threading.Thread.Interrupt() or <code>Future::cancel(boolean)</code> (on Java 1.5) should use <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_directory.html" title="A straightforward implementation of FSDirectory using java.io.RandomAccessFile. However, this class has poor concurrent performance (multiple threads will bottleneck) as it synchronizes when multiple threads read from the same file. It's usually better to use NIOFSDirectory or MMapDirectory instead. ">SimpleFSDirectory</a> instead. See <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_m_map_directory.html" title="File-based Directory implementation that uses mmap for reading, and SimpleFSDirectory.SimpleFSIndexOutput for writing.">MMapDirectory</a> java doc for details. </p> |
| </li> |
| </ul> |
| <p>Unfortunately, because of system peculiarities, there is no single overall best implementation. Therefore, we've added the Open(System.IO.DirectoryInfo) method, to allow <a class="el" href="namespace_lucene.html">Lucene</a> to choose the best <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> implementation given your environment, and the known limitations of each implementation. For users who have no reason to prefer a specific implementation, it's best to simply use FSDirectory.Open(System.IO.DirectoryInfo) . For all others, you should instantiate the desired implementation directly.</p> |
| <p>The locking implementation is by default <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock_factory.html" title="Implements LockFactory using native OS file locks. Note that because this LockFactory relies on java...">NativeFSLockFactory</a> , but can be changed by passing in a custom <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> instance. </p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00104">104</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a6d9a6a69f92227518d5e27a0363f58b0"></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.Store.FSDirectory.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Removes an existing file in the directory. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#ad3722fbcf237e9b2297d7834b6f09192">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00374">374</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a10db6d3563f9a06e5eacecb4b23c1aaa"></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.Store.FSDirectory.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#abbc8e1b070b3186a1b7587d415535739">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00470">470</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab98439d9a00c3d8b5c737250c9f5590c"></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.Store.FSDirectory.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns true iff a file with the given name exists. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#abff8f4b9909c5f197b18270a7ed8985c">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00335">335</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="add4ee39c195491aeff84ee4592a84be4"></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.Store.FSDirectory.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the length in bytes of a file in the directory. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#aaf0539c5a4613457a1dbdc81a169f49f">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00366">366</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aca2ba2225c3c5f65a1d00dc38005d392"></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.Store.FSDirectory.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the time the named file was last modified. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#a6335b0e675938d9106c71666018eac51">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00343">343</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6c00a49d9b26eadc0a3849f206462e97"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static long Lucene.Net.Store.FSDirectory.FileModified </td> |
| <td>(</td> |
| <td class="paramtype">System.IO.FileInfo </td> |
| <td class="paramname"><em>directory</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</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>Returns the time the named file was last modified. </p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00351">351</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af05baabb53c64d7de5cff18b1ce2d7f4"></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.Store.FSDirectory.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 from <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#adfb37c848971f09208379edd8d022618">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00440">440</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4e5a5dfe5f2b8038044dcc3f20f7fa81"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static System.String [] Lucene.Net.Store.FSDirectory.ListAll </td> |
| <td>(</td> |
| <td class="paramtype">System.IO.DirectoryInfo </td> |
| <td class="paramname"><em>dir</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Lists all files (not subdirectories) in the directory. This method never returns null (throws System.IO.IOException instead). </p> |
| <p><throws> <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_no_such_directory_exception.html" title="This exception is thrown when you try to list a non-existent directory. ">NoSuchDirectoryException</a> if the directory </throws> </p> |
| <p>does not exist, or does exist but is not a directory. </p> |
| <p><throws> IOException if list() returns null </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00297">297</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aca5d785ceced2914a18c848d2481a068"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String [] Lucene.Net.Store.FSDirectory.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Lists all files (not subdirectories) in the directory. </p> |
| <dl class="section see"><dt>See Also</dt><dd>ListAll(System.IO.DirectoryInfo)</dd></dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#abfb7e6d495559d12b84ffb9758e1b15d">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00328">328</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a33ea2927779ca535c4cb90ea0dc76cfa"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html">FSDirectory</a> Lucene.Net.Store.FSDirectory.Open </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates an <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> instance, trying to pick the best implementation given the current environment. The directory returned uses the <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock_factory.html" title="Implements LockFactory using native OS file locks. Note that because this LockFactory relies on java...">NativeFSLockFactory</a>. </p> |
| <p>Currently this returns <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_directory.html" title="A straightforward implementation of FSDirectory using java.io.RandomAccessFile. However, this class has poor concurrent performance (multiple threads will bottleneck) as it synchronizes when multiple threads read from the same file. It's usually better to use NIOFSDirectory or MMapDirectory instead. ">SimpleFSDirectory</a> as <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_n_i_o_f_s_directory.html" title="Not implemented. Waiting for volunteers. ">NIOFSDirectory</a> is currently not supported.</p> |
| <p><b>NOTE</b>: this method may suddenly change which implementation is returned from release to release, in the event that higher performance defaults become possible; if the precise implementation is important to your application, please instantiate it directly, instead. On 64 bit systems, it may also good to return <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_m_map_directory.html" title="File-based Directory implementation that uses mmap for reading, and SimpleFSDirectory.SimpleFSIndexOutput for writing.">MMapDirectory</a>, but this is disabled because of officially missing unmap support in Java. For optimal performance you should consider using this implementation on 64 bit JVMs.</p> |
| <p>See <a href="#subclasses">above</a> </p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00234">234</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4d1e2d61b9d1ab690e6714b05026d9de"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html">FSDirectory</a> Lucene.Net.Store.FSDirectory.Open </td> |
| <td>(</td> |
| <td class="paramtype">System.IO.DirectoryInfo </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates an <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> instance, trying to pick the best implementation given the current environment. The directory returned uses the <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock_factory.html" title="Implements LockFactory using native OS file locks. Note that because this LockFactory relies on java...">NativeFSLockFactory</a>. </p> |
| <p>Currently this returns <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_directory.html" title="A straightforward implementation of FSDirectory using java.io.RandomAccessFile. However, this class has poor concurrent performance (multiple threads will bottleneck) as it synchronizes when multiple threads read from the same file. It's usually better to use NIOFSDirectory or MMapDirectory instead. ">SimpleFSDirectory</a> as <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_n_i_o_f_s_directory.html" title="Not implemented. Waiting for volunteers. ">NIOFSDirectory</a> is currently not supported.</p> |
| <p><b>NOTE</b>: this method may suddenly change which implementation is returned from release to release, in the event that higher performance defaults become possible; if the precise implementation is important to your application, please instantiate it directly, instead. On 64 bit systems, it may also good to return <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_m_map_directory.html" title="File-based Directory implementation that uses mmap for reading, and SimpleFSDirectory.SimpleFSIndexOutput for writing.">MMapDirectory</a>, but this is disabled because of officially missing unmap support in Java. For optimal performance you should consider using this implementation on 64 bit JVMs.</p> |
| <p>See <a href="#subclasses">above</a> </p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00259">259</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae69df4a802e0f14d19428a5591c00d9f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html">FSDirectory</a> Lucene.Net.Store.FSDirectory.Open </td> |
| <td>(</td> |
| <td class="paramtype">System.IO.DirectoryInfo </td> |
| <td class="paramname"><em>path</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_lock_factory.html">LockFactory</a> </td> |
| <td class="paramname"><em>lockFactory</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>Just like Open(System.IO.DirectoryInfo), but allows you to also specify a custom <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>. </p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00267">267</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a471b2089fdd070fd543b1ffad3659ab6"></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_index_input.html">IndexInput</a> Lucene.Net.Store.FSDirectory.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a stream reading an existing file. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#af08fb715df704bf7e0eb6f67e491b3c8">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00430">430</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abd334a77552a373adef367d6707d30ba"></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.Store.FSDirectory.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 from <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#a1b5473afa8d8883972556956d638071c">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00388">388</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1e632c5890208be7253c513430483271"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Store.FSDirectory.ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>For debug output. </p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00491">491</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7c57302da469d7b122d29d64e935effc"></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.Store.FSDirectory.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the modified time of an existing file to now. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html#ad374ac4d5b071ea364db40a0139b9574">Lucene.Net.Store.Directory</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00358">358</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="acf0169542a81c156510161d16aaf355d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">readonly int Lucene.Net.Store.FSDirectory.DEFAULT_READ_CHUNK_SIZE = Constants.JRE_IS_64BIT ? int.MaxValue: 100 * 1024 * 1024</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>Default read chunk size. This is a conditional default: on 32bit JVMs, it defaults to 100 MB. On 64bit JVMs, it's <code>Integer.MAX_VALUE</code>. </p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a15f6b09d7e61e94574f16a7f1af47683" title="The maximum number of bytes to read at once from the underlying file during IndexInput.ReadBytes(byte[],int,int). ">ReadChunkSize</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00502">502</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="aa3d77002a85376ccd723d5cc0af8bdd6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual DirectoryInfo Lucene.Net.Store.FSDirectory.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="_f_s_directory_8cs_source.html#l00482">482</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a15f6b09d7e61e94574f16a7f1af47683"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Store.FSDirectory.ReadChunkSize</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The maximum number of bytes to read at once from the underlying file during <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_index_input.html#a428913bea51c264523f8c6cecba321e3" title="Reads a specified number of bytes into an array at the specified offset.">IndexInput.ReadBytes(byte[],int,int)</a>. </p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html#a15f6b09d7e61e94574f16a7f1af47683" title="The maximum number of bytes to read at once from the underlying file during IndexInput.ReadBytes(byte[],int,int). ">ReadChunkSize</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_f_s_directory_8cs_source.html#l00513">513</a> of file <a class="el" href="_f_s_directory_8cs_source.html">FSDirectory.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="_f_s_directory_8cs_source.html">FSDirectory.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> |
