docs/3.0.3/class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html - lucenenet-site - Git at Google

 <!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.Util.Cache.SegmentCache&lt; T &gt; Class Template 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_util.html">Util</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_util_1_1_cache.html">Cache</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html">SegmentCache< T ></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="#pro-methods">Protected Member Functions</a> &#124;
 <a href="#properties">Properties</a> &#124;
 <a href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4-members.html">List of all members</a>  </div>
   <div class="headertitle">
 <div class="title">Lucene.Net.Util.Cache.SegmentCache&lt; T &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>Custom cache with two levels of keys, outer key is the IndexReader with the inner key being a string, commonly a field name but can be anything. Refer to the unit tests for an example implementation. </p>
 <dl class="tparams"><dt>Template Parameters</dt><dd>
   <table class="tparams">
     <tr><td class="paramname">T</td><td>The type that is being cached.</td></tr>
   </table>
   </dd>
 </dl>

  <a href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html#details">More...</a></p>

 <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_abstract_segment_cache.html">Lucene.Net.Util.Cache.AbstractSegmentCache</a>.</p>

 <p>Inherited by Lucene.Net.Util.Cache.SegmentCache&lt; T &gt;.WeakKey.</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>WeakKey</b></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A weak referene wrapper for the hashtable keys. Whenever a key pair is added to the hashtable, the key is wrapped using a WeakKey. WeakKey saves the value of the original object hashcode for fast comparison. <br/></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:acda3709f24faf09c6ba4ee8fe6d56c7a"><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_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html#acda3709f24faf09c6ba4ee8fe6d56c7a">Warm</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, string key)</td></tr>
 <tr class="memdesc:acda3709f24faf09c6ba4ee8fe6d56c7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Warm the cache - simply calls Get and ignores the return value.  <a href="#acda3709f24faf09c6ba4ee8fe6d56c7a"></a><br/></td></tr>
 <tr class="separator:acda3709f24faf09c6ba4ee8fe6d56c7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3876abbc6bc31638b6748dbb2e82faf2"><td class="memItemLeft" align="right" valign="top">virtual T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html#a3876abbc6bc31638b6748dbb2e82faf2">Get</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, string key)</td></tr>
 <tr class="memdesc:a3876abbc6bc31638b6748dbb2e82faf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the item from the cache.  <a href="#a3876abbc6bc31638b6748dbb2e82faf2"></a><br/></td></tr>
 <tr class="separator:a3876abbc6bc31638b6748dbb2e82faf2"><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:a26d16f3344e803ea2d75340b92cecc36"><td class="memItemLeft" align="right" valign="top">abstract T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html#a26d16f3344e803ea2d75340b92cecc36">CreateValue</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, string key)</td></tr>
 <tr class="memdesc:a26d16f3344e803ea2d75340b92cecc36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value creation.  <a href="#a26d16f3344e803ea2d75340b92cecc36"></a><br/></td></tr>
 <tr class="separator:a26d16f3344e803ea2d75340b92cecc36"><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:aa77f8b41d021438180735e7cc9a29b34"><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_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html#aa77f8b41d021438180735e7cc9a29b34">KeyCount</a><code> [get]</code></td></tr>
 <tr class="memdesc:aa77f8b41d021438180735e7cc9a29b34"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of outermost keys in the collection.  <a href="#aa77f8b41d021438180735e7cc9a29b34"></a><br/></td></tr>
 <tr class="separator:aa77f8b41d021438180735e7cc9a29b34"><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>Custom cache with two levels of keys, outer key is the IndexReader with the inner key being a string, commonly a field name but can be anything. Refer to the unit tests for an example implementation. </p>
 <dl class="tparams"><dt>Template Parameters</dt><dd>
   <table class="tparams">
     <tr><td class="paramname">T</td><td>The type that is being cached.</td></tr>
   </table>
   </dd>
 </dl>

 <p>Definition at line <a class="el" href="_segment_cache_8cs_source.html#l00048">48</a> of file <a class="el" href="_segment_cache_8cs_source.html">SegmentCache.cs</a>.</p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
 <a class="anchor" id="a26d16f3344e803ea2d75340b92cecc36"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">abstract T Lucene.Net.Util.Cache.SegmentCache&lt; T &gt;.CreateValue </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>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">string&#160;</td>
           <td class="paramname"><em>key</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Value creation. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">reader</td><td>The reader.</td></tr>
     <tr><td class="paramname">key</td><td>The key to the item under the reader.</td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>The value.</dd></dl>

 </div>
 </div>
 <a class="anchor" id="a3876abbc6bc31638b6748dbb2e82faf2"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">virtual T Lucene.Net.Util.Cache.SegmentCache&lt; T &gt;.Get </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>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">string&#160;</td>
           <td class="paramname"><em>key</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Get the item from the cache. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">reader</td><td>The IndexReader the cache is from.</td></tr>
     <tr><td class="paramname">key</td><td>The key of the item under the reader.</td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>The item from cache.</dd></dl>

 <p>Definition at line <a class="el" href="_segment_cache_8cs_source.html#l00092">92</a> of file <a class="el" href="_segment_cache_8cs_source.html">SegmentCache.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="acda3709f24faf09c6ba4ee8fe6d56c7a"></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.Util.Cache.SegmentCache&lt; T &gt;.Warm </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>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">string&#160;</td>
           <td class="paramname"><em>key</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Warm the cache - simply calls Get and ignores the return value. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">reader</td><td>The index reader to warm up.</td></tr>
     <tr><td class="paramname">key</td><td>The key of the item under the reader.</td></tr>
   </table>
   </dd>
 </dl>

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_abstract_segment_cache.html#a389bf624e21538bab565851bc2fd463c">Lucene.Net.Util.Cache.AbstractSegmentCache</a>.</p>

 <p>Definition at line <a class="el" href="_segment_cache_8cs_source.html#l00081">81</a> of file <a class="el" href="_segment_cache_8cs_source.html">SegmentCache.cs</a>.</p>

 </div>
 </div>
 <h2 class="groupheader">Property Documentation</h2>
 <a class="anchor" id="aa77f8b41d021438180735e7cc9a29b34"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">int Lucene.Net.Util.Cache.SegmentCache&lt; T &gt;.KeyCount</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>The number of outermost keys in the collection. </p>

 <p>Definition at line <a class="el" href="_segment_cache_8cs_source.html#l00072">72</a> of file <a class="el" href="_segment_cache_8cs_source.html">SegmentCache.cs</a>.</p>

 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
 <li>contrib/Core/Util/Cache/<a class="el" href="_segment_cache_8cs_source.html">SegmentCache.cs</a></li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated on Thu Jan 3 2013 02:12:59 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>
	<!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.Util.Cache.SegmentCache< T > Class Template 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_util.html">Util</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_util_1_1_cache.html">Cache</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html">SegmentCache< T ></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="#pro-methods">Protected Member Functions</a> \|
	<a href="#properties">Properties</a> \|
	<a href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4-members.html">List of all members</a> </div>
	<div class="headertitle">
	<div class="title">Lucene.Net.Util.Cache.SegmentCache< T > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
	</div><!--header-->
	<div class="contents">

	<p>Custom cache with two levels of keys, outer key is the IndexReader with the inner key being a string, commonly a field name but can be anything. Refer to the unit tests for an example implementation. </p>
	<dl class="tparams"><dt>Template Parameters</dt><dd>
	<table class="tparams">
	<tr><td class="paramname">T</td><td>The type that is being cached.</td></tr>
	</table>
	</dd>
	</dl>

	<a href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html#details">More...</a></p>

	<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_abstract_segment_cache.html">Lucene.Net.Util.Cache.AbstractSegmentCache</a>.</p>

	<p>Inherited by Lucene.Net.Util.Cache.SegmentCache< T >.WeakKey.</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  </td><td class="memItemRight" valign="bottom"><b>WeakKey</b></td></tr>
	<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A weak referene wrapper for the hashtable keys. Whenever a key pair is added to the hashtable, the key is wrapped using a WeakKey. WeakKey saves the value of the original object hashcode for fast comparison. <br/></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </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:acda3709f24faf09c6ba4ee8fe6d56c7a"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html#acda3709f24faf09c6ba4ee8fe6d56c7a">Warm</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, string key)</td></tr>
	<tr class="memdesc:acda3709f24faf09c6ba4ee8fe6d56c7a"><td class="mdescLeft"> </td><td class="mdescRight">Warm the cache - simply calls Get and ignores the return value. <a href="#acda3709f24faf09c6ba4ee8fe6d56c7a"></a><br/></td></tr>
	<tr class="separator:acda3709f24faf09c6ba4ee8fe6d56c7a"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a3876abbc6bc31638b6748dbb2e82faf2"><td class="memItemLeft" align="right" valign="top">virtual T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html#a3876abbc6bc31638b6748dbb2e82faf2">Get</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, string key)</td></tr>
	<tr class="memdesc:a3876abbc6bc31638b6748dbb2e82faf2"><td class="mdescLeft"> </td><td class="mdescRight">Get the item from the cache. <a href="#a3876abbc6bc31638b6748dbb2e82faf2"></a><br/></td></tr>
	<tr class="separator:a3876abbc6bc31638b6748dbb2e82faf2"><td class="memSeparator" colspan="2"> </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:a26d16f3344e803ea2d75340b92cecc36"><td class="memItemLeft" align="right" valign="top">abstract T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html#a26d16f3344e803ea2d75340b92cecc36">CreateValue</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, string key)</td></tr>
	<tr class="memdesc:a26d16f3344e803ea2d75340b92cecc36"><td class="mdescLeft"> </td><td class="mdescRight">Value creation. <a href="#a26d16f3344e803ea2d75340b92cecc36"></a><br/></td></tr>
	<tr class="separator:a26d16f3344e803ea2d75340b92cecc36"><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:aa77f8b41d021438180735e7cc9a29b34"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_segment_cache_3_01_t_01_4.html#aa77f8b41d021438180735e7cc9a29b34">KeyCount</a><code> [get]</code></td></tr>
	<tr class="memdesc:aa77f8b41d021438180735e7cc9a29b34"><td class="mdescLeft"> </td><td class="mdescRight">The number of outermost keys in the collection. <a href="#aa77f8b41d021438180735e7cc9a29b34"></a><br/></td></tr>
	<tr class="separator:aa77f8b41d021438180735e7cc9a29b34"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Custom cache with two levels of keys, outer key is the IndexReader with the inner key being a string, commonly a field name but can be anything. Refer to the unit tests for an example implementation. </p>
	<dl class="tparams"><dt>Template Parameters</dt><dd>
	<table class="tparams">
	<tr><td class="paramname">T</td><td>The type that is being cached.</td></tr>
	</table>
	</dd>
	</dl>

	<p>Definition at line <a class="el" href="_segment_cache_8cs_source.html#l00048">48</a> of file <a class="el" href="_segment_cache_8cs_source.html">SegmentCache.cs</a>.</p>
	</div><h2 class="groupheader">Member Function Documentation</h2>
	<a class="anchor" id="a26d16f3344e803ea2d75340b92cecc36"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="mlabels">
	<tr>
	<td class="mlabels-left">
	<table class="memname">
	<tr>
	<td class="memname">abstract T Lucene.Net.Util.Cache.SegmentCache< T >.CreateValue </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> </td>
	<td class="paramname"><em>reader</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">string </td>
	<td class="paramname"><em>key</em> </td>
	</tr>
	<tr>
	<td></td>
	<td>)</td>
	<td></td><td></td>
	</tr>
	</table>
	</td>
	<td class="mlabels-right">
	<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Value creation. </p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">reader</td><td>The reader.</td></tr>
	<tr><td class="paramname">key</td><td>The key to the item under the reader.</td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd>The value.</dd></dl>

	</div>
	</div>
	<a class="anchor" id="a3876abbc6bc31638b6748dbb2e82faf2"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="mlabels">
	<tr>
	<td class="mlabels-left">
	<table class="memname">
	<tr>
	<td class="memname">virtual T Lucene.Net.Util.Cache.SegmentCache< T >.Get </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> </td>
	<td class="paramname"><em>reader</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">string </td>
	<td class="paramname"><em>key</em> </td>
	</tr>
	<tr>
	<td></td>
	<td>)</td>
	<td></td><td></td>
	</tr>
	</table>
	</td>
	<td class="mlabels-right">
	<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Get the item from the cache. </p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">reader</td><td>The IndexReader the cache is from.</td></tr>
	<tr><td class="paramname">key</td><td>The key of the item under the reader.</td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd>The item from cache.</dd></dl>

	<p>Definition at line <a class="el" href="_segment_cache_8cs_source.html#l00092">92</a> of file <a class="el" href="_segment_cache_8cs_source.html">SegmentCache.cs</a>.</p>

	</div>
	</div>
	<a class="anchor" id="acda3709f24faf09c6ba4ee8fe6d56c7a"></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.Util.Cache.SegmentCache< T >.Warm </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> </td>
	<td class="paramname"><em>reader</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">string </td>
	<td class="paramname"><em>key</em> </td>
	</tr>
	<tr>
	<td></td>
	<td>)</td>
	<td></td><td></td>
	</tr>
	</table>
	</td>
	<td class="mlabels-right">
	<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Warm the cache - simply calls Get and ignores the return value. </p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">reader</td><td>The index reader to warm up.</td></tr>
	<tr><td class="paramname">key</td><td>The key of the item under the reader.</td></tr>
	</table>
	</dd>
	</dl>

	<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_abstract_segment_cache.html#a389bf624e21538bab565851bc2fd463c">Lucene.Net.Util.Cache.AbstractSegmentCache</a>.</p>

	<p>Definition at line <a class="el" href="_segment_cache_8cs_source.html#l00081">81</a> of file <a class="el" href="_segment_cache_8cs_source.html">SegmentCache.cs</a>.</p>

	</div>
	</div>
	<h2 class="groupheader">Property Documentation</h2>
	<a class="anchor" id="aa77f8b41d021438180735e7cc9a29b34"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="mlabels">
	<tr>
	<td class="mlabels-left">
	<table class="memname">
	<tr>
	<td class="memname">int Lucene.Net.Util.Cache.SegmentCache< T >.KeyCount</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>The number of outermost keys in the collection. </p>

	<p>Definition at line <a class="el" href="_segment_cache_8cs_source.html#l00072">72</a> of file <a class="el" href="_segment_cache_8cs_source.html">SegmentCache.cs</a>.</p>

	</div>
	</div>
	<hr/>The documentation for this class was generated from the following file:<ul>
	<li>contrib/Core/Util/Cache/<a class="el" href="_segment_cache_8cs_source.html">SegmentCache.cs</a></li>
	</ul>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated on Thu Jan 3 2013 02:12:59 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>