| <!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.Search.CacheEntry 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 |
|  <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_search.html">Search</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html">CacheEntry</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_cache_entry-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.CacheEntry Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>EXPERT: A unique Identifier/Description for each item in the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. Can be useful for logging/debugging. <b>EXPERIMENTAL API:</b> This API is considered extremely advanced and experimental. It may be removed or altered w/o warning in future releases of <a class="el" href="namespace_lucene.html">Lucene</a>. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#details">More...</a></p> |
| |
| <p>Inherited by Lucene.Net.Search.FieldCacheImpl.CacheEntryImpl.</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:a71002880ed02badbdf2d13142f45cfd8"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#a71002880ed02badbdf2d13142f45cfd8">EstimateSize</a> ()</td></tr> |
| <tr class="separator:a71002880ed02badbdf2d13142f45cfd8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16c79801a3813a5c49e4a4f373e76f46"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#a16c79801a3813a5c49e4a4f373e76f46">EstimateSize</a> (<a class="el" href="_field_cache_8cs.html#a8fe8b15bd7dabdd402db14e16f90dbe7">RamUsageEstimator</a> ramCalc)</td></tr> |
| <tr class="memdesc:a16c79801a3813a5c49e4a4f373e76f46"><td class="mdescLeft"> </td><td class="mdescRight">Computes (and stores) the estimated size of the cache Value <a href="#a16c79801a3813a5c49e4a4f373e76f46"></a><br/></td></tr> |
| <tr class="separator:a16c79801a3813a5c49e4a4f373e76f46"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2cf2a4d8840d2d11c5dccf3bfeb20782"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#a2cf2a4d8840d2d11c5dccf3bfeb20782">ToString</a> ()</td></tr> |
| <tr class="separator:a2cf2a4d8840d2d11c5dccf3bfeb20782"><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:a791a43a162f9a0a55c518ae1a2806a40"><td class="memItemLeft" align="right" valign="top">abstract object </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#a791a43a162f9a0a55c518ae1a2806a40">ReaderKey</a><code> [get]</code></td></tr> |
| <tr class="separator:a791a43a162f9a0a55c518ae1a2806a40"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1291acf0fd7ca629f18204cbaab6eee5"><td class="memItemLeft" align="right" valign="top">abstract string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#a1291acf0fd7ca629f18204cbaab6eee5">FieldName</a><code> [get]</code></td></tr> |
| <tr class="separator:a1291acf0fd7ca629f18204cbaab6eee5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a342021dc1538cce5496adb024ca68cc0"><td class="memItemLeft" align="right" valign="top">abstract Type </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#a342021dc1538cce5496adb024ca68cc0">CacheType</a><code> [get]</code></td></tr> |
| <tr class="separator:a342021dc1538cce5496adb024ca68cc0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2b6466b6b03267a737af978220892586"><td class="memItemLeft" align="right" valign="top">abstract object </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#a2b6466b6b03267a737af978220892586">Custom</a><code> [get]</code></td></tr> |
| <tr class="separator:a2b6466b6b03267a737af978220892586"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2cda871065e54be6d1e904dcf0254d00"><td class="memItemLeft" align="right" valign="top">abstract object </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#a2cda871065e54be6d1e904dcf0254d00">Value</a><code> [get]</code></td></tr> |
| <tr class="separator:a2cda871065e54be6d1e904dcf0254d00"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aea0ef73560efaace479fa60be8988a47"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#aea0ef73560efaace479fa60be8988a47">EstimatedSize</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:aea0ef73560efaace479fa60be8988a47"><td class="mdescLeft"> </td><td class="mdescRight">The most recently estimated size of the value, null unless estimateSize has been called. <a href="#aea0ef73560efaace479fa60be8988a47"></a><br/></td></tr> |
| <tr class="separator:aea0ef73560efaace479fa60be8988a47"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>EXPERT: A unique Identifier/Description for each item in the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. Can be useful for logging/debugging. </p> |
| <p><b>EXPERIMENTAL API:</b> This API is considered extremely advanced and experimental. It may be removed or altered w/o warning in future releases of <a class="el" href="namespace_lucene.html">Lucene</a>. </p> |
| |
| <p>Definition at line <a class="el" href="_field_cache_8cs_source.html#l00097">97</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a71002880ed02badbdf2d13142f45cfd8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Search.CacheEntry.EstimateSize </td> |
| <td>(</td> |
| <td class="paramname"></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"> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#a16c79801a3813a5c49e4a4f373e76f46" title="Computes (and stores) the estimated size of the cache Value ">EstimateSize(RamUsageEstimator)</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_field_cache_8cs_source.html#l00107">107</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a16c79801a3813a5c49e4a4f373e76f46"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void Lucene.Net.Search.CacheEntry.EstimateSize </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="_field_cache_8cs.html#a8fe8b15bd7dabdd402db14e16f90dbe7">RamUsageEstimator</a> </td> |
| <td class="paramname"><em>ramCalc</em></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>Computes (and stores) the estimated size of the cache Value </p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html#aea0ef73560efaace479fa60be8988a47" title="The most recently estimated size of the value, null unless estimateSize has been called. ">EstimatedSize</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_field_cache_8cs_source.html#l00114">114</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2cf2a4d8840d2d11c5dccf3bfeb20782"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Search.CacheEntry.ToString </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="_field_cache_8cs_source.html#l00126">126</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a342021dc1538cce5496adb024ca68cc0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract Type Lucene.Net.Search.CacheEntry.CacheType</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="_field_cache_8cs_source.html#l00101">101</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2b6466b6b03267a737af978220892586"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract object Lucene.Net.Search.CacheEntry.Custom</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="_field_cache_8cs_source.html#l00102">102</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aea0ef73560efaace479fa60be8988a47"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Lucene.Net.Search.CacheEntry.EstimatedSize</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The most recently estimated size of the value, null unless estimateSize has been called. </p> |
| |
| <p>Definition at line <a class="el" href="_field_cache_8cs_source.html#l00123">123</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1291acf0fd7ca629f18204cbaab6eee5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract string Lucene.Net.Search.CacheEntry.FieldName</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="_field_cache_8cs_source.html#l00100">100</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a791a43a162f9a0a55c518ae1a2806a40"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract object Lucene.Net.Search.CacheEntry.ReaderKey</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="_field_cache_8cs_source.html#l00099">99</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2cda871065e54be6d1e904dcf0254d00"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract object Lucene.Net.Search.CacheEntry.Value</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="_field_cache_8cs_source.html#l00103">103</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Search/<a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:56 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> |