blob: 5bcc5c985b81a30f14e547ea1ce8c5c7b34e6688 [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.ReusableStringReader 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_reusable_string_reader.html">ReusableStringReader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_index_1_1_reusable_string_reader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.ReusableStringReader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Used by <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_documents_writer.html" title="This class accepts multiple added documents and directly writes a single segment file. It does this more efficiently than creating a single segment per document (with DocumentWriter) and doing standard merges on those segments.">DocumentsWriter</a> to implemented a StringReader that can be reset to a new string; we use this when tokenizing the string value from a Field.
<a href="class_lucene_1_1_net_1_1_index_1_1_reusable_string_reader.html#details">More...</a></p>
<p>Inherits TextReader.</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:a0d90466a38d78dbcefda2c7bd444df81"><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_reusable_string_reader.html#a0d90466a38d78dbcefda2c7bd444df81">Read</a> (char[] c)</td></tr>
<tr class="separator:a0d90466a38d78dbcefda2c7bd444df81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37a9a16758af0f7965c008cb2733ffba"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_reusable_string_reader.html#a37a9a16758af0f7965c008cb2733ffba">Read</a> (System.Char[] c, int off, int len)</td></tr>
<tr class="separator:a37a9a16758af0f7965c008cb2733ffba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefc0b0e93aca69b388855807f708aae8"><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_reusable_string_reader.html#aefc0b0e93aca69b388855807f708aae8">Close</a> ()</td></tr>
<tr class="separator:aefc0b0e93aca69b388855807f708aae8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6c099db173b60e81140d0e58400aff7"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_reusable_string_reader.html#ab6c099db173b60e81140d0e58400aff7">Read</a> ()</td></tr>
<tr class="separator:ab6c099db173b60e81140d0e58400aff7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fc829bc6f51059dc0b659832b6890bf"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_reusable_string_reader.html#a0fc829bc6f51059dc0b659832b6890bf">ReadBlock</a> (char[] buffer, int index, int count)</td></tr>
<tr class="separator:a0fc829bc6f51059dc0b659832b6890bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c657d09ca3a0f3e42cf63ef6cf45aac"><td class="memItemLeft" align="right" valign="top">override string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_reusable_string_reader.html#a3c657d09ca3a0f3e42cf63ef6cf45aac">ReadLine</a> ()</td></tr>
<tr class="separator:a3c657d09ca3a0f3e42cf63ef6cf45aac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa569e99f94f2f11ea9c0c74ef40c0564"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_reusable_string_reader.html#aa569e99f94f2f11ea9c0c74ef40c0564">Peek</a> ()</td></tr>
<tr class="separator:aa569e99f94f2f11ea9c0c74ef40c0564"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a506001f7815b65c14300e2ba6499a2c9"><td class="memItemLeft" align="right" valign="top">override string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_reusable_string_reader.html#a506001f7815b65c14300e2ba6499a2c9">ReadToEnd</a> ()</td></tr>
<tr class="separator:a506001f7815b65c14300e2ba6499a2c9"><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>Used by <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_documents_writer.html" title="This class accepts multiple added documents and directly writes a single segment file. It does this more efficiently than creating a single segment per document (with DocumentWriter) and doing standard merges on those segments.">DocumentsWriter</a> to implemented a StringReader that can be reset to a new string; we use this when tokenizing the string value from a Field. </p>
<p>Definition at line <a class="el" href="_reusable_string_reader_8cs_source.html#l00028">28</a> of file <a class="el" href="_reusable_string_reader_8cs_source.html">ReusableStringReader.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aefc0b0e93aca69b388855807f708aae8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Index.ReusableStringReader.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="_reusable_string_reader_8cs_source.html#l00071">71</a> of file <a class="el" href="_reusable_string_reader_8cs_source.html">ReusableStringReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aa569e99f94f2f11ea9c0c74ef40c0564"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Index.ReusableStringReader.Peek </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="_reusable_string_reader_8cs_source.html#l00119">119</a> of file <a class="el" href="_reusable_string_reader_8cs_source.html">ReusableStringReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a0d90466a38d78dbcefda2c7bd444df81"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Index.ReusableStringReader.Read </td>
<td>(</td>
<td class="paramtype">char[]&#160;</td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_reusable_string_reader_8cs_source.html#l00040">40</a> of file <a class="el" href="_reusable_string_reader_8cs_source.html">ReusableStringReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a37a9a16758af0f7965c008cb2733ffba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Index.ReusableStringReader.Read </td>
<td>(</td>
<td class="paramtype">System.Char[]&#160;</td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>off</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>Definition at line <a class="el" href="_reusable_string_reader_8cs_source.html#l00045">45</a> of file <a class="el" href="_reusable_string_reader_8cs_source.html">ReusableStringReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab6c099db173b60e81140d0e58400aff7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Index.ReusableStringReader.Read </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="_reusable_string_reader_8cs_source.html#l00076">76</a> of file <a class="el" href="_reusable_string_reader_8cs_source.html">ReusableStringReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a0fc829bc6f51059dc0b659832b6890bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Index.ReusableStringReader.ReadBlock </td>
<td>(</td>
<td class="paramtype">char[]&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>count</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_reusable_string_reader_8cs_source.html#l00088">88</a> of file <a class="el" href="_reusable_string_reader_8cs_source.html">ReusableStringReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a3c657d09ca3a0f3e42cf63ef6cf45aac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override string Lucene.Net.Index.ReusableStringReader.ReadLine </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="_reusable_string_reader_8cs_source.html#l00093">93</a> of file <a class="el" href="_reusable_string_reader_8cs_source.html">ReusableStringReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a506001f7815b65c14300e2ba6499a2c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override string Lucene.Net.Index.ReusableStringReader.ReadToEnd </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="_reusable_string_reader_8cs_source.html#l00128">128</a> of file <a class="el" href="_reusable_string_reader_8cs_source.html">ReusableStringReader.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="_reusable_string_reader_8cs_source.html">ReusableStringReader.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>