Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_norm.html
blob: 9c5f4e8e28507dc48e46f41013d987583ea97771 [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.SegmentReader.Norm 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_reader.html">SegmentReader</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_norm.html">Norm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_norm-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.SegmentReader.Norm Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Byte[] referencing is used because a new norm object needs to be created for each clone, and the byte array is all that is needed for sharing between cloned readers. The current norm referencing is for sharing between readers whereas the byte[] referencing is for copy on write which is independent of reader references (i.e. incRef, decRef).
<a href="class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_norm.html#details">More...</a></p>
<p>Inherits ICloneable.</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:aa6510e8a6c00d05f59bf1174d0b3b798"><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_reader_1_1_norm.html#aa6510e8a6c00d05f59bf1174d0b3b798">Norm</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader.html">SegmentReader</a> enclosingInstance, <a class="el" href="_byte_slice_reader_8cs.html#a12195e9150e4d7af469b90ac95cc47ee">IndexInput</a> in_Renamed, int number, long normSeek)</td></tr>
<tr class="separator:aa6510e8a6c00d05f59bf1174d0b3b798"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bdf4a791379f35e49fb877499e22323"><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_reader_1_1_norm.html#a3bdf4a791379f35e49fb877499e22323">IncRef</a> ()</td></tr>
<tr class="separator:a3bdf4a791379f35e49fb877499e22323"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48c11d94451c507746540b20aa17e2b5"><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_reader_1_1_norm.html#a48c11d94451c507746540b20aa17e2b5">DecRef</a> ()</td></tr>
<tr class="separator:a48c11d94451c507746540b20aa17e2b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40d5fc681fb165d496d77fde8455ded5"><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_reader_1_1_norm.html#a40d5fc681fb165d496d77fde8455ded5">Bytes</a> (byte[] bytesOut, int offset, int len)</td></tr>
<tr class="separator:a40d5fc681fb165d496d77fde8455ded5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a585c46d764b2c93a274e794514f8c153"><td class="memItemLeft" align="right" valign="top">byte[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_norm.html#a585c46d764b2c93a274e794514f8c153">Bytes</a> ()</td></tr>
<tr class="separator:a585c46d764b2c93a274e794514f8c153"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ad5b035780d439f31c7402d0feaf243"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_ref.html">Ref</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_norm.html#a2ad5b035780d439f31c7402d0feaf243">BytesRef</a> ()</td></tr>
<tr class="separator:a2ad5b035780d439f31c7402d0feaf243"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a48125a9df3781f0fce678903923c10"><td class="memItemLeft" align="right" valign="top">byte[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_norm.html#a9a48125a9df3781f0fce678903923c10">CopyOnWrite</a> ()</td></tr>
<tr class="separator:a9a48125a9df3781f0fce678903923c10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44ad13ab73b8348367710be396f4ab71"><td class="memItemLeft" align="right" valign="top">System.Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_norm.html#a44ad13ab73b8348367710be396f4ab71">Clone</a> ()</td></tr>
<tr class="separator:a44ad13ab73b8348367710be396f4ab71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adea3e4b53ab43964ce5575f93a15aa46"><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_reader_1_1_norm.html#adea3e4b53ab43964ce5575f93a15aa46">ReWrite</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_info.html">SegmentInfo</a> si)</td></tr>
<tr class="separator:adea3e4b53ab43964ce5575f93a15aa46"><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:a9fde14b033bddd5f2d29323aefd53103"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader.html">SegmentReader</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_norm.html#a9fde14b033bddd5f2d29323aefd53103">Enclosing_Instance</a><code> [get]</code></td></tr>
<tr class="separator:a9fde14b033bddd5f2d29323aefd53103"><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>Byte[] referencing is used because a new norm object needs to be created for each clone, and the byte array is all that is needed for sharing between cloned readers. The current norm referencing is for sharing between readers whereas the byte[] referencing is for copy on write which is independent of reader references (i.e. incRef, decRef). </p>
<p>Definition at line <a class="el" href="_segment_reader_8cs_source.html#l00451">451</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa6510e8a6c00d05f59bf1174d0b3b798"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Index.SegmentReader.Norm.Norm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader.html">SegmentReader</a>&#160;</td>
<td class="paramname"><em>enclosingInstance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_byte_slice_reader_8cs.html#a12195e9150e4d7af469b90ac95cc47ee">IndexInput</a>&#160;</td>
<td class="paramname"><em>in_Renamed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>normSeek</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="_segment_reader_8cs_source.html#l00482">482</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a40d5fc681fb165d496d77fde8455ded5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Index.SegmentReader.Norm.Bytes </td>
<td>(</td>
<td class="paramtype">byte[]&#160;</td>
<td class="paramname"><em>bytesOut</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>Definition at line <a class="el" href="_segment_reader_8cs_source.html#l00558">558</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a585c46d764b2c93a274e794514f8c153"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">byte [] Lucene.Net.Index.SegmentReader.Norm.Bytes </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="_segment_reader_8cs_source.html#l00591">591</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2ad5b035780d439f31c7402d0feaf243"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_reader_1_1_ref.html">Ref</a> Lucene.Net.Index.SegmentReader.Norm.BytesRef </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="_segment_reader_8cs_source.html#l00641">641</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a44ad13ab73b8348367710be396f4ab71"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">System.Object Lucene.Net.Index.SegmentReader.Norm.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="_segment_reader_8cs_source.html#l00674">674</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a9a48125a9df3781f0fce678903923c10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">byte [] Lucene.Net.Index.SegmentReader.Norm.CopyOnWrite </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="_segment_reader_8cs_source.html#l00648">648</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a48c11d94451c507746540b20aa17e2b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Index.SegmentReader.Norm.DecRef </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="_segment_reader_8cs_source.html#l00523">523</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a3bdf4a791379f35e49fb877499e22323"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Index.SegmentReader.Norm.IncRef </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="_segment_reader_8cs_source.html#l00490">490</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="adea3e4b53ab43964ce5575f93a15aa46"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Index.SegmentReader.Norm.ReWrite </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_info.html">SegmentInfo</a>&#160;</td>
<td class="paramname"><em>si</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_segment_reader_8cs_source.html#l00720">720</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a9fde14b033bddd5f2d29323aefd53103"></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="class_lucene_1_1_net_1_1_index_1_1_segment_reader.html">SegmentReader</a> Lucene.Net.Index.SegmentReader.Norm.Enclosing_Instance</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="_segment_reader_8cs_source.html#l00459">459</a> of file <a class="el" href="_segment_reader_8cs_source.html">SegmentReader.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_reader_8cs_source.html">SegmentReader.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>