blob: 45c4b6b2e20d62c533c28fec01eb731edef50201 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Index.SegmentMerger Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html">SegmentMerger</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_index_1_1_segment_merger-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.SegmentMerger Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html" title="The SegmentMerger class combines two or more Segments, represented by an IndexReader (Add...">SegmentMerger</a> class combines two or more Segments, represented by an <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html" title="IndexReader is an abstract class, providing an interface for accessing an index. Search of an index i...">IndexReader</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#a0f3e8f23783a2846d224c8c6c4316556" title="Add an IndexReader to the collection of readers that are to be merged">Add</a>, into a single Segment. After adding the appropriate readers, call the merge method to combine the segments. If the compoundFile flag is set, then the segments will be merged into a compound file.
<a href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><b>CheckAbort</b></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:afd5f8ee8f8ae7afd01379bc19ac8dc52"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#afd5f8ee8f8ae7afd01379bc19ac8dc52">SegmentMerger</a> (<a class="el" href="_syns2_index_8cs.html#aada057080323f6e867d8f9c189276716">Directory</a> dir, System.String name)</td></tr>
<tr class="memdesc:afd5f8ee8f8ae7afd01379bc19ac8dc52"><td class="mdescLeft">&#160;</td><td class="mdescRight">This ctor used only by test code. <a href="#afd5f8ee8f8ae7afd01379bc19ac8dc52"></a><br/></td></tr>
<tr class="separator:afd5f8ee8f8ae7afd01379bc19ac8dc52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f3e8f23783a2846d224c8c6c4316556"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#a0f3e8f23783a2846d224c8c6c4316556">Add</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader)</td></tr>
<tr class="memdesc:a0f3e8f23783a2846d224c8c6c4316556"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html" title="IndexReader is an abstract class, providing an interface for accessing an index. Search of an index i...">IndexReader</a> to the collection of readers that are to be merged <a href="#a0f3e8f23783a2846d224c8c6c4316556"></a><br/></td></tr>
<tr class="separator:a0f3e8f23783a2846d224c8c6c4316556"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e1716904ba37be94844c106b4bd148b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#a7e1716904ba37be94844c106b4bd148b">Merge</a> ()</td></tr>
<tr class="memdesc:a7e1716904ba37be94844c106b4bd148b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Merges the readers specified by the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#a0f3e8f23783a2846d224c8c6c4316556" title="Add an IndexReader to the collection of readers that are to be merged">Add</a> method into the directory passed to the constructor <a href="#a7e1716904ba37be94844c106b4bd148b"></a><br/></td></tr>
<tr class="separator:a7e1716904ba37be94844c106b4bd148b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abed234683ddd595ae84c63150c683538"><td class="memItemLeft" align="right" valign="top">ICollection&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#abed234683ddd595ae84c63150c683538">CreateCompoundFile</a> (System.String fileName)</td></tr>
<tr class="separator:abed234683ddd595ae84c63150c683538"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html" title="The SegmentMerger class combines two or more Segments, represented by an IndexReader (Add...">SegmentMerger</a> class combines two or more Segments, represented by an <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html" title="IndexReader is an abstract class, providing an interface for accessing an index. Search of an index i...">IndexReader</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#a0f3e8f23783a2846d224c8c6c4316556" title="Add an IndexReader to the collection of readers that are to be merged">Add</a>, into a single Segment. After adding the appropriate readers, call the merge method to combine the segments. </p>
<p>If the compoundFile flag is set, then the segments will be merged into a compound file. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#a7e1716904ba37be94844c106b4bd148b" title="Merges the readers specified by the Add method into the directory passed to the constructor">Merge()</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#a0f3e8f23783a2846d224c8c6c4316556" title="Add an IndexReader to the collection of readers that are to be merged">Add</a></dd></dl>
<p>Definition at line <a class="el" href="_segment_merger_8cs_source.html#l00044">44</a> of file <a class="el" href="_segment_merger_8cs_source.html">SegmentMerger.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="afd5f8ee8f8ae7afd01379bc19ac8dc52"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Index.SegmentMerger.SegmentMerger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_syns2_index_8cs.html#aada057080323f6e867d8f9c189276716">Directory</a>&#160;</td>
<td class="paramname"><em>dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This ctor used only by test code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dir</td><td>The Directory to merge the other segments into </td></tr>
<tr><td class="paramname">name</td><td>The name of the new segment </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_segment_merger_8cs_source.html#l00132">132</a> of file <a class="el" href="_segment_merger_8cs_source.html">SegmentMerger.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0f3e8f23783a2846d224c8c6c4316556"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Index.SegmentMerger.Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html" title="IndexReader is an abstract class, providing an interface for accessing an index. Search of an index i...">IndexReader</a> to the collection of readers that are to be merged</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td></td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_segment_merger_8cs_source.html#l00164">164</a> of file <a class="el" href="_segment_merger_8cs_source.html">SegmentMerger.cs</a>.</p>
</div>
</div>
<a class="anchor" id="abed234683ddd595ae84c63150c683538"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ICollection&lt;string&gt; Lucene.Net.Index.SegmentMerger.CreateCompoundFile </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>fileName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_segment_merger_8cs_source.html#l00272">272</a> of file <a class="el" href="_segment_merger_8cs_source.html">SegmentMerger.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a7e1716904ba37be94844c106b4bd148b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Index.SegmentMerger.Merge </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Merges the readers specified by the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_merger.html#a0f3e8f23783a2846d224c8c6c4316556" title="Add an IndexReader to the collection of readers that are to be merged">Add</a> method into the directory passed to the constructor</p>
<dl class="section return"><dt>Returns</dt><dd>The number of documents that were merged </dd></dl>
<p>&lt;throws&gt; <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_corrupt_index_exception.html" title="This exception is thrown when Lucene detects an inconsistency in the index. ">CorruptIndexException</a> if the index is corrupt &lt;/throws&gt; &lt;throws&gt; IOException if there is a low-level IO error &lt;/throws&gt; </p>
<p>Definition at line <a class="el" href="_segment_merger_8cs_source.html#l00184">184</a> of file <a class="el" href="_segment_merger_8cs_source.html">SegmentMerger.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="_segment_merger_8cs_source.html">SegmentMerger.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:55 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>