| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.3"/> |
| <title>Lucene.Net: Lucene.Net.Index.CompoundFileWriter Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="Index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Packages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_writer.html">CompoundFileWriter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_index_1_1_compound_file_writer-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.CompoundFileWriter Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Combines multiple files into a single compound file. The file format:<br/> |
| </p> |
| <ul> |
| <li> |
| VInt fileCount </li> |
| <li> |
| {Directory} fileCount entries with the following structure: <ul> |
| <li> |
| long dataOffset </li> |
| <li> |
| String fileName </li> |
| </ul> |
| </li> |
| <li> |
| {File Data} fileCount entries with the raw data of the corresponding file </li> |
| </ul> |
| |
| <a href="class_lucene_1_1_net_1_1_index_1_1_compound_file_writer.html#details">More...</a></p> |
| |
| <p>Inherits IDisposable.</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:a423d15af6e923e65fe01239e3d6ea375"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_writer.html#a423d15af6e923e65fe01239e3d6ea375">CompoundFileWriter</a> (<a class="el" href="_syns2_index_8cs.html#aada057080323f6e867d8f9c189276716">Directory</a> dir, System.String name)</td></tr> |
| <tr class="memdesc:a423d15af6e923e65fe01239e3d6ea375"><td class="mdescLeft"> </td><td class="mdescRight">Create the compound stream in the specified file. The file name is the entire name (no extensions are added). <a href="#a423d15af6e923e65fe01239e3d6ea375"></a><br/></td></tr> |
| <tr class="separator:a423d15af6e923e65fe01239e3d6ea375"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5b2cdef99143f3acae3b0e89ddbfe7d"><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_index_1_1_compound_file_writer.html#ab5b2cdef99143f3acae3b0e89ddbfe7d">AddFile</a> (String file)</td></tr> |
| <tr class="memdesc:ab5b2cdef99143f3acae3b0e89ddbfe7d"><td class="mdescLeft"> </td><td class="mdescRight">Add a source stream. <code>file</code> is the string by which the sub-stream will be known in the compound stream. <a href="#ab5b2cdef99143f3acae3b0e89ddbfe7d"></a><br/></td></tr> |
| <tr class="separator:ab5b2cdef99143f3acae3b0e89ddbfe7d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a55c24a06766c87b2057792695a6cedf0"><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_index_1_1_compound_file_writer.html#a55c24a06766c87b2057792695a6cedf0">Close</a> ()</td></tr> |
| <tr class="separator:a55c24a06766c87b2057792695a6cedf0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ada2da4d04486a4037c08c0e27ab57d10"><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_index_1_1_compound_file_writer.html#ada2da4d04486a4037c08c0e27ab57d10">Dispose</a> ()</td></tr> |
| <tr class="memdesc:ada2da4d04486a4037c08c0e27ab57d10"><td class="mdescLeft"> </td><td class="mdescRight">Merge files with the extensions added up to now. All files with these extensions are combined sequentially into the compound stream. After successful merge, the source files are deleted. <a href="#ada2da4d04486a4037c08c0e27ab57d10"></a><br/></td></tr> |
| <tr class="separator:ada2da4d04486a4037c08c0e27ab57d10"><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:a9dcde5a7217e7eaf2e2f59c012047144"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_syns2_index_8cs.html#aada057080323f6e867d8f9c189276716">Directory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_writer.html#a9dcde5a7217e7eaf2e2f59c012047144">Directory</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a9dcde5a7217e7eaf2e2f59c012047144"><td class="mdescLeft"> </td><td class="mdescRight">Returns the directory of the compound file. <a href="#a9dcde5a7217e7eaf2e2f59c012047144"></a><br/></td></tr> |
| <tr class="separator:a9dcde5a7217e7eaf2e2f59c012047144"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3f4d6fceb9dd0b3da7730fcc1cbfc423"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_writer.html#a3f4d6fceb9dd0b3da7730fcc1cbfc423">Name</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a3f4d6fceb9dd0b3da7730fcc1cbfc423"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the compound file. <a href="#a3f4d6fceb9dd0b3da7730fcc1cbfc423"></a><br/></td></tr> |
| <tr class="separator:a3f4d6fceb9dd0b3da7730fcc1cbfc423"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Combines multiple files into a single compound file. The file format:<br/> |
| </p> |
| <ul> |
| <li> |
| VInt fileCount </li> |
| <li> |
| {Directory} fileCount entries with the following structure: <ul> |
| <li> |
| long dataOffset </li> |
| <li> |
| String fileName </li> |
| </ul> |
| </li> |
| <li> |
| {File Data} fileCount entries with the raw data of the corresponding file </li> |
| </ul> |
| <p>The fileCount integer indicates how many files are contained in this compound file. The {directory} that follows has that many entries. Each directory entry contains a long pointer to the start of this file's data section, and a String with that file's name. </p> |
| |
| <p>Definition at line <a class="el" href="_compound_file_writer_8cs_source.html#l00047">47</a> of file <a class="el" href="_compound_file_writer_8cs_source.html">CompoundFileWriter.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a423d15af6e923e65fe01239e3d6ea375"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Index.CompoundFileWriter.CompoundFileWriter </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="_syns2_index_8cs.html#aada057080323f6e867d8f9c189276716">Directory</a> </td> |
| <td class="paramname"><em>dir</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> |
| </div><div class="memdoc"> |
| |
| <p>Create the compound stream in the specified file. The file name is the entire name (no extensions are added). </p> |
| <p><throws> NullPointerException if <code>dir</code> or <code>name</code> is null </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_compound_file_writer_8cs_source.html#l00074">74</a> of file <a class="el" href="_compound_file_writer_8cs_source.html">CompoundFileWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ab5b2cdef99143f3acae3b0e89ddbfe7d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.CompoundFileWriter.AddFile </td> |
| <td>(</td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>file</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Add a source stream. <code>file</code> is the string by which the sub-stream will be known in the compound stream. </p> |
| <p><throws> IllegalStateException if this writer is closed </throws> <throws> NullPointerException if <code>file</code> is null </throws> <throws> IllegalArgumentException if a file with the same name </throws> </p> |
| <p>has been added already </p> |
| |
| <p>Definition at line <a class="el" href="_compound_file_writer_8cs_source.html#l00112">112</a> of file <a class="el" href="_compound_file_writer_8cs_source.html">CompoundFileWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a55c24a06766c87b2057792695a6cedf0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.CompoundFileWriter.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="_compound_file_writer_8cs_source.html#l00134">134</a> of file <a class="el" href="_compound_file_writer_8cs_source.html">CompoundFileWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ada2da4d04486a4037c08c0e27ab57d10"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Index.CompoundFileWriter.Dispose </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Merge files with the extensions added up to now. All files with these extensions are combined sequentially into the compound stream. After successful merge, the source files are deleted. </p> |
| <p><throws> IllegalStateException if close() had been called before or </throws> </p> |
| <p>if no file has been added to this object </p> |
| |
| <p>Definition at line <a class="el" href="_compound_file_writer_8cs_source.html#l00147">147</a> of file <a class="el" href="_compound_file_writer_8cs_source.html">CompoundFileWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a9dcde5a7217e7eaf2e2f59c012047144"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="_syns2_index_8cs.html#aada057080323f6e867d8f9c189276716">Directory</a> Lucene.Net.Index.CompoundFileWriter.Directory</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the directory of the compound file. </p> |
| |
| <p>Definition at line <a class="el" href="_compound_file_writer_8cs_source.html#l00093">93</a> of file <a class="el" href="_compound_file_writer_8cs_source.html">CompoundFileWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3f4d6fceb9dd0b3da7730fcc1cbfc423"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Lucene.Net.Index.CompoundFileWriter.Name</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the name of the compound file. </p> |
| |
| <p>Definition at line <a class="el" href="_compound_file_writer_8cs_source.html#l00099">99</a> of file <a class="el" href="_compound_file_writer_8cs_source.html">CompoundFileWriter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Index/<a class="el" href="_compound_file_writer_8cs_source.html">CompoundFileWriter.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:50 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
