blob: ccaecaa008812be575ed4452ad88a08b7021d224 [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: core/Util/FieldCacheSanityChecker.cs File 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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#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="dir_1efe588324fc547683bba4a3f1bac847.html">core</a></li><li class="navelem"><a class="el" href="dir_d1ecf42529ca901cc6a3edb20ba43b64.html">Util</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">FieldCacheSanityChecker.cs File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="_field_cache_sanity_checker_8cs_source.html">Go to the source code of this file.</a></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"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_field_cache_sanity_checker.html">Lucene.Net.Util.FieldCacheSanityChecker</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides methods for sanity checking that entries in the FieldCache are not wasteful or inconsistent. <a class="el" href="namespace_lucene.html">Lucene</a> 2.9 Introduced numerous enhancements into how the FieldCache is used by the low levels of <a class="el" href="namespace_lucene.html">Lucene</a> searching (for Sorting and ValueSourceQueries) to improve both the speed for Sorting, as well as reopening of IndexReaders. But these changes have shifted the usage of FieldCache from "top level" IndexReaders (frequently a MultiReader or DirectoryReader) down to the leaf level SegmentReaders. As a result, existing applications that directly access the FieldCache may find RAM usage increase significantly when upgrading to 2.9 or Later. This class provides an API for these applications (or their Unit tests) to check at run time if the FieldCache contains "insane" usages of the FieldCache. <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_util_1_1_field_cache_sanity_checker.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_field_cache_sanity_checker_1_1_insanity.html">Lucene.Net.Util.FieldCacheSanityChecker.Insanity</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple container for a collection of related CacheEntry objects that in conjunction with eachother represent some "insane" usage of the FieldCache. <a href="class_lucene_1_1_net_1_1_util_1_1_field_cache_sanity_checker_1_1_insanity.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_field_cache_sanity_checker_1_1_insanity_type.html">Lucene.Net.Util.FieldCacheSanityChecker.InsanityType</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An Enumaration of the differnet types of "insane" behavior that may be detected in a FieldCache. <a href="class_lucene_1_1_net_1_1_util_1_1_field_cache_sanity_checker_1_1_insanity_type.html#details">More...</a><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="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespace_lucene_1_1_net_1_1_util"><td class="memItemLeft" align="right" valign="top">package &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lucene_1_1_net_1_1_util.html">Lucene.Net.Util</a></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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a2a6914ea10bbe06764856e29e5674e66"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_field_cache_sanity_checker_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> = <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">Lucene.Net.Index.IndexReader</a></td></tr>
<tr class="separator:a2a6914ea10bbe06764856e29e5674e66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3da15e75141cdc8cab8107899059bb1"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_field_cache_sanity_checker_8cs.html#ae3da15e75141cdc8cab8107899059bb1">FieldCache</a> = <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">Lucene.Net.Search.FieldCache</a></td></tr>
<tr class="separator:ae3da15e75141cdc8cab8107899059bb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05df5ab03f0f06e160c237beadddc8ee"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_field_cache_sanity_checker_8cs.html#a05df5ab03f0f06e160c237beadddc8ee">CacheEntry</a> = <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html">Lucene.Net.Search.CacheEntry</a></td></tr>
<tr class="separator:a05df5ab03f0f06e160c237beadddc8ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a05df5ab03f0f06e160c237beadddc8ee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="_field_cache_sanity_checker_8cs.html#a05df5ab03f0f06e160c237beadddc8ee">CacheEntry</a> = <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html">Lucene.Net.Search.CacheEntry</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_field_cache_sanity_checker_8cs_source.html#l00023">23</a> of file <a class="el" href="_field_cache_sanity_checker_8cs_source.html">FieldCacheSanityChecker.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae3da15e75141cdc8cab8107899059bb1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="_numeric_field_8cs.html#ae3da15e75141cdc8cab8107899059bb1">FieldCache</a> = <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">Lucene.Net.Search.FieldCache</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_field_cache_sanity_checker_8cs_source.html#l00022">22</a> of file <a class="el" href="_field_cache_sanity_checker_8cs_source.html">FieldCacheSanityChecker.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2a6914ea10bbe06764856e29e5674e66"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> = <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">Lucene.Net.Index.IndexReader</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_field_cache_sanity_checker_8cs_source.html#l00021">21</a> of file <a class="el" href="_field_cache_sanity_checker_8cs_source.html">FieldCacheSanityChecker.cs</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:47 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>