Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html
blob: 0de64bc07433f6cf655bae418bf0a106ae3892b0 [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.Search.CachingWrapperFilter 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_search.html">Search</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html">CachingWrapperFilter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.CachingWrapperFilter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Wraps another filter's result and caches it. The purpose is to allow filters to simply filter, and then wrap with this class to add caching.
<a href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html">Lucene.Net.Search.Filter</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"><b>FilterCache&lt; T &gt;</b></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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a14585403da294c38023fd5070f946172"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a14585403da294c38023fd5070f946172">DeletesMode</a> { <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a14585403da294c38023fd5070f946172aa2e843feab94ef623fea888f07c28696">IGNORE</a>,
<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a14585403da294c38023fd5070f946172a1c5cfe8ec21c4d006482c97ab9929cd2">RECACHE</a>,
<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a14585403da294c38023fd5070f946172a0fcc90da4811c877ba9f9c12f7d60bc9">DYNAMIC</a>
}</td></tr>
<tr class="separator:a14585403da294c38023fd5070f946172"><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:a4a82f414e7817ad28b6e9f1c18ddb275"><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_search_1_1_caching_wrapper_filter.html#a4a82f414e7817ad28b6e9f1c18ddb275">CachingWrapperFilter</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html">Filter</a> filter)</td></tr>
<tr class="memdesc:a4a82f414e7817ad28b6e9f1c18ddb275"><td class="mdescLeft">&#160;</td><td class="mdescRight">New deletes are ignored by default, which gives higher cache hit rate on reopened readers. Most of the time this is safe, because the filter will be AND'd with a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> that fully enforces deletions. If instead you need this filter to always enforce deletions, pass either DeletesMode.RECACHE or DeletesMode.DYNAMIC. <a href="#a4a82f414e7817ad28b6e9f1c18ddb275"></a><br/></td></tr>
<tr class="separator:a4a82f414e7817ad28b6e9f1c18ddb275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65892c65a94c6c8adb85d1dcbc141bd7"><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_search_1_1_caching_wrapper_filter.html#a65892c65a94c6c8adb85d1dcbc141bd7">CachingWrapperFilter</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html">Filter</a> filter, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a14585403da294c38023fd5070f946172">DeletesMode</a> deletesMode)</td></tr>
<tr class="memdesc:a65892c65a94c6c8adb85d1dcbc141bd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: by default, the cached filter will be shared across reopened segments that only had changes to their deletions. <a href="#a65892c65a94c6c8adb85d1dcbc141bd7"></a><br/></td></tr>
<tr class="separator:a65892c65a94c6c8adb85d1dcbc141bd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6331e109689ac5b8aafaf8cf0094f737"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html">DocIdSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a6331e109689ac5b8aafaf8cf0094f737">GetDocIdSet</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader)</td></tr>
<tr class="memdesc:a6331e109689ac5b8aafaf8cf0094f737"><td class="mdescLeft">&#160;</td><td class="mdescRight"> <a href="#a6331e109689ac5b8aafaf8cf0094f737"></a><br/></td></tr>
<tr class="separator:a6331e109689ac5b8aafaf8cf0094f737"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1a2a139ccd7e91ba9d498b988391707"><td class="memItemLeft" align="right" valign="top">override System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#af1a2a139ccd7e91ba9d498b988391707">ToString</a> ()</td></tr>
<tr class="separator:af1a2a139ccd7e91ba9d498b988391707"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d222ceadb32e4bd87c2bd73b4a12a10"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a7d222ceadb32e4bd87c2bd73b4a12a10">Equals</a> (System.Object o)</td></tr>
<tr class="separator:a7d222ceadb32e4bd87c2bd73b4a12a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d21caf03572425612fd3d15c23a5869"><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_search_1_1_caching_wrapper_filter.html#a0d21caf03572425612fd3d15c23a5869">GetHashCode</a> ()</td></tr>
<tr class="separator:a0d21caf03572425612fd3d15c23a5869"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a79d87129a75aa6446d2cb5aff51ae314"><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_search_1_1_caching_wrapper_filter.html#a79d87129a75aa6446d2cb5aff51ae314">hitCount</a></td></tr>
<tr class="separator:a79d87129a75aa6446d2cb5aff51ae314"><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>Wraps another filter's result and caches it. The purpose is to allow filters to simply filter, and then wrap with this class to add caching. </p>
<p>Definition at line <a class="el" href="_caching_wrapper_filter_8cs_source.html#l00033">33</a> of file <a class="el" href="_caching_wrapper_filter_8cs_source.html">CachingWrapperFilter.cs</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a14585403da294c38023fd5070f946172"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a14585403da294c38023fd5070f946172">Lucene.Net.Search.CachingWrapperFilter.DeletesMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Expert: Specifies how new deletions against a reopened reader should be handled.</p>
<p>The default is IGNORE, which means the cache entry will be re-used for a given segment, even when that segment has been reopened due to changes in deletions. This is a big performance gain, especially with near-real-timer readers, since you don't hit a cache miss on every reopened reader for prior segments.</p>
<p>However, in some cases this can cause invalid query results, allowing deleted documents to be returned. This only happens if the main query does not rule out deleted documents on its own, such as a toplevel <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_constant_score_query.html" title="A query that wraps a filter and simply returns a constant score equal to the query boost for every do...">ConstantScoreQuery</a>. To fix this, use RECACHE to re-create the cached filter (at a higher per-reopen cost, but at faster subsequent search performance), or use DYNAMIC to dynamically intersect deleted docs (fast reopen time but some hit to search performance).</p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a14585403da294c38023fd5070f946172aa2e843feab94ef623fea888f07c28696"></a>IGNORE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a14585403da294c38023fd5070f946172a1c5cfe8ec21c4d006482c97ab9929cd2"></a>RECACHE</em>&nbsp;</td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a14585403da294c38023fd5070f946172a0fcc90da4811c877ba9f9c12f7d60bc9"></a>DYNAMIC</em>&nbsp;</td><td class="fielddoc">
</td></tr>
</table>
<p>Definition at line <a class="el" href="_caching_wrapper_filter_8cs_source.html#l00058">58</a> of file <a class="el" href="_caching_wrapper_filter_8cs_source.html">CachingWrapperFilter.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4a82f414e7817ad28b6e9f1c18ddb275"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.CachingWrapperFilter.CachingWrapperFilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html">Filter</a>&#160;</td>
<td class="paramname"><em>filter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>New deletes are ignored by default, which gives higher cache hit rate on reopened readers. Most of the time this is safe, because the filter will be AND'd with a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> that fully enforces deletions. If instead you need this filter to always enforce deletions, pass either DeletesMode.RECACHE or DeletesMode.DYNAMIC. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html" title="Abstract base class for restricting which documents may be returned during searching.">Filter</a> to cache results of</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_caching_wrapper_filter_8cs_source.html#l00158">158</a> of file <a class="el" href="_caching_wrapper_filter_8cs_source.html">CachingWrapperFilter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a65892c65a94c6c8adb85d1dcbc141bd7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.CachingWrapperFilter.CachingWrapperFilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html">Filter</a>&#160;</td>
<td class="paramname"><em>filter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a14585403da294c38023fd5070f946172">DeletesMode</a>&#160;</td>
<td class="paramname"><em>deletesMode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Expert: by default, the cached filter will be shared across reopened segments that only had changes to their deletions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html" title="Abstract base class for restricting which documents may be returned during searching.">Filter</a> to cache results of</td></tr>
<tr><td class="paramname">deletesMode</td><td>See <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a14585403da294c38023fd5070f946172">DeletesMode</a></td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_caching_wrapper_filter_8cs_source.html#l00170">170</a> of file <a class="el" href="_caching_wrapper_filter_8cs_source.html">CachingWrapperFilter.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7d222ceadb32e4bd87c2bd73b4a12a10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Search.CachingWrapperFilter.Equals </td>
<td>(</td>
<td class="paramtype">System.Object&#160;</td>
<td class="paramname"><em>o</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_caching_wrapper_filter_8cs_source.html#l00267">267</a> of file <a class="el" href="_caching_wrapper_filter_8cs_source.html">CachingWrapperFilter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6331e109689ac5b8aafaf8cf0094f737"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html">DocIdSet</a> Lucene.Net.Search.CachingWrapperFilter.GetDocIdSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</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></p>
<p>Creates a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html" title="A DocIdSet contains a set of doc ids. Implementing classes must only implement Iterator to provide ac...">DocIdSet</a> enumerating the documents that should be permitted in search results. <b>NOTE:</b> null can be returned if no documents are accepted by this <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html" title="Abstract base class for restricting which documents may be returned during searching.">Filter</a>.</p>
<p>Note: This method will be called once per segment in the index during searching. The returned <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html" title="A DocIdSet contains a set of doc ids. Implementing classes must only implement Iterator to provide ac...">DocIdSet</a> must refer to document IDs for that segment, not for the top-level reader.</p>
<p>/summary&gt; </p>
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html" title="A DocIdSet contains a set of doc ids. Implementing classes must only implement Iterator to provide ac...">DocIdSet</a> that provides the documents which should be permitted or prohibited in search results. <b>NOTE:</b> null can be returned if no documents will be accepted by this <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html" title="Abstract base class for restricting which documents may be returned during searching.">Filter</a>. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>A <a class="el" href="_reader_util_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> instance opened on the index currently searched on. Note, it is likely that the provided reader does not represent the whole underlying index i.e. if the index has more than one segment the given reader only represents a single segment. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="_filter_8cs.html#a673a4822c0bf5f5fdadb59f7ad92338c">DocIdBitSet</a></dd></dl>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html#a6acd9f9caec9c3a4adba5580593f76c7">Lucene.Net.Search.Filter</a>.</p>
<p>Definition at line <a class="el" href="_caching_wrapper_filter_8cs_source.html#l00238">238</a> of file <a class="el" href="_caching_wrapper_filter_8cs_source.html">CachingWrapperFilter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a0d21caf03572425612fd3d15c23a5869"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Search.CachingWrapperFilter.GetHashCode </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="_caching_wrapper_filter_8cs_source.html#l00274">274</a> of file <a class="el" href="_caching_wrapper_filter_8cs_source.html">CachingWrapperFilter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af1a2a139ccd7e91ba9d498b988391707"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.String Lucene.Net.Search.CachingWrapperFilter.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="_caching_wrapper_filter_8cs_source.html#l00262">262</a> of file <a class="el" href="_caching_wrapper_filter_8cs_source.html">CachingWrapperFilter.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a79d87129a75aa6446d2cb5aff51ae314"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Search.CachingWrapperFilter.hitCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_caching_wrapper_filter_8cs_source.html#l00236">236</a> of file <a class="el" href="_caching_wrapper_filter_8cs_source.html">CachingWrapperFilter.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="_caching_wrapper_filter_8cs_source.html">CachingWrapperFilter.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 &#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>