blob: a65d575f59da4e924b60becf352196c59e117aca [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.CompoundFileReader.CSIndexInput 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_compound_file_reader.html">CompoundFileReader</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html">CSIndexInput</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.CompoundFileReader.CSIndexInput Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implementation of an IndexInput that reads from a portion of the compound file. The visibility is left as "package" <em>only</em> because this helps with testing since JUnit test cases in a different class can then access package fields of this class.
<a href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html#details">More...</a></p>
<p>Inherits BufferedIndexInput.</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:a86eb5cf1f3a3b72e1f0b713e071b2603"><td class="memItemLeft" align="right" valign="top">override System.Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html#a86eb5cf1f3a3b72e1f0b713e071b2603">Clone</a> ()</td></tr>
<tr class="separator:a86eb5cf1f3a3b72e1f0b713e071b2603"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabf1f54c86a95a749d06966bf96d3110"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html#aabf1f54c86a95a749d06966bf96d3110">ReadInternal</a> (byte[] b, int offset, int len)</td></tr>
<tr class="memdesc:aabf1f54c86a95a749d06966bf96d3110"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: implements buffer refill. Reads bytes from the current position in the input. <a href="#aabf1f54c86a95a749d06966bf96d3110"></a><br/></td></tr>
<tr class="separator:aabf1f54c86a95a749d06966bf96d3110"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfa12707227a278fdc8bb1b1fe949da6"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html#acfa12707227a278fdc8bb1b1fe949da6">SeekInternal</a> (long pos)</td></tr>
<tr class="memdesc:acfa12707227a278fdc8bb1b1fe949da6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: implements seek. Sets current position in this file, where the next <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html#aabf1f54c86a95a749d06966bf96d3110" title="Expert: implements buffer refill. Reads bytes from the current position in the input. ">ReadInternal(byte[],int,int)</a> will occur. <a href="#acfa12707227a278fdc8bb1b1fe949da6"></a><br/></td></tr>
<tr class="separator:acfa12707227a278fdc8bb1b1fe949da6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac50ad0211797a872d37541d490fc627b"><td class="memItemLeft" align="right" valign="top">override long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html#ac50ad0211797a872d37541d490fc627b">Length</a> ()</td></tr>
<tr class="separator:ac50ad0211797a872d37541d490fc627b"><td class="memSeparator" colspan="2">&#160;</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:a461bd0f142265d177664351a467d7bd1"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html#a461bd0f142265d177664351a467d7bd1">Dispose</a> (bool disposing)</td></tr>
<tr class="separator:a461bd0f142265d177664351a467d7bd1"><td class="memSeparator" colspan="2">&#160;</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:a7f9cb68b2e9e940dc420b676c599c635"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_byte_slice_reader_8cs.html#a12195e9150e4d7af469b90ac95cc47ee">IndexInput</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html#a7f9cb68b2e9e940dc420b676c599c635">base_Renamed_ForNUnit</a><code> [get]</code></td></tr>
<tr class="separator:a7f9cb68b2e9e940dc420b676c599c635"><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>Implementation of an IndexInput that reads from a portion of the compound file. The visibility is left as "package" <em>only</em> because this helps with testing since JUnit test cases in a different class can then access package fields of this class. </p>
<p>Definition at line <a class="el" href="_compound_file_reader_8cs_source.html#l00236">236</a> of file <a class="el" href="_compound_file_reader_8cs_source.html">CompoundFileReader.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a86eb5cf1f3a3b72e1f0b713e071b2603"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.Object Lucene.Net.Index.CompoundFileReader.CSIndexInput.Clone </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_reader_8cs_source.html#l00255">255</a> of file <a class="el" href="_compound_file_reader_8cs_source.html">CompoundFileReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a461bd0f142265d177664351a467d7bd1"></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.Index.CompoundFileReader.CSIndexInput.Dispose </td>
<td>(</td>
<td class="paramtype">bool&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_compound_file_reader_8cs_source.html#l00291">291</a> of file <a class="el" href="_compound_file_reader_8cs_source.html">CompoundFileReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ac50ad0211797a872d37541d490fc627b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override long Lucene.Net.Index.CompoundFileReader.CSIndexInput.Length </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_reader_8cs_source.html#l00306">306</a> of file <a class="el" href="_compound_file_reader_8cs_source.html">CompoundFileReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aabf1f54c86a95a749d06966bf96d3110"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Index.CompoundFileReader.CSIndexInput.ReadInternal </td>
<td>(</td>
<td class="paramtype">byte[]&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Expert: implements buffer refill. Reads bytes from the current position in the input. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>the array to read bytes into </td></tr>
<tr><td class="paramname">offset</td><td>the offset in the array to start storing bytes </td></tr>
<tr><td class="paramname">len</td><td>the number of bytes to read </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_compound_file_reader_8cs_source.html#l00273">273</a> of file <a class="el" href="_compound_file_reader_8cs_source.html">CompoundFileReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="acfa12707227a278fdc8bb1b1fe949da6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Index.CompoundFileReader.CSIndexInput.SeekInternal </td>
<td>(</td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>pos</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Expert: implements seek. Sets current position in this file, where the next <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html#aabf1f54c86a95a749d06966bf96d3110" title="Expert: implements buffer refill. Reads bytes from the current position in the input. ">ReadInternal(byte[],int,int)</a> will occur. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_compound_file_reader_1_1_c_s_index_input.html#aabf1f54c86a95a749d06966bf96d3110" title="Expert: implements buffer refill. Reads bytes from the current position in the input. ">ReadInternal(byte[],int,int)</a></dd></dl>
<p>Definition at line <a class="el" href="_compound_file_reader_8cs_source.html#l00287">287</a> of file <a class="el" href="_compound_file_reader_8cs_source.html">CompoundFileReader.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a7f9cb68b2e9e940dc420b676c599c635"></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="_byte_slice_reader_8cs.html#a12195e9150e4d7af469b90ac95cc47ee">IndexInput</a> Lucene.Net.Index.CompoundFileReader.CSIndexInput.base_Renamed_ForNUnit</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_compound_file_reader_8cs_source.html#l00312">312</a> of file <a class="el" href="_compound_file_reader_8cs_source.html">CompoundFileReader.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_reader_8cs_source.html">CompoundFileReader.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 &#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>