blob: ca816c3d76cecf23d75e6da7d97e7c72eb4a5d1e [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.FilteredQuery 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_filtered_query.html">FilteredQuery</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="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_filtered_query-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.FilteredQuery Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A query that applies a filter to the results of another query.
<a href="class_lucene_1_1_net_1_1_search_1_1_filtered_query.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Lucene.Net.Search.Query</a>.</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:a8a3f275553a87900c7867665cebcff83"><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_filtered_query.html#a8a3f275553a87900c7867665cebcff83">FilteredQuery</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html">Filter</a> filter)</td></tr>
<tr class="memdesc:a8a3f275553a87900c7867665cebcff83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new query which applies a filter to the results of the original query. Filter.getDocIdSet() will be called every time this query is used in a search. <a href="#a8a3f275553a87900c7867665cebcff83"></a><br/></td></tr>
<tr class="separator:a8a3f275553a87900c7867665cebcff83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07286244f5217f54af2418e3b1234313"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html">Weight</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_query.html#a07286244f5217f54af2418e3b1234313">CreateWeight</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html">Searcher</a> searcher)</td></tr>
<tr class="memdesc:a07286244f5217f54af2418e3b1234313"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a> that applies the filter to the enclosed query's <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a>. This is accomplished by overriding the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> returned by the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a>. <a href="#a07286244f5217f54af2418e3b1234313"></a><br/></td></tr>
<tr class="separator:a07286244f5217f54af2418e3b1234313"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d958fad1e512fc8cbe05f68543556ab"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_query.html#a2d958fad1e512fc8cbe05f68543556ab">Rewrite</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader)</td></tr>
<tr class="memdesc:a2d958fad1e512fc8cbe05f68543556ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rewrites the wrapped query. <a href="#a2d958fad1e512fc8cbe05f68543556ab"></a><br/></td></tr>
<tr class="separator:a2d958fad1e512fc8cbe05f68543556ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c4b746f9e7408de3155f7d7aa62cd1b"><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_search_1_1_filtered_query.html#a4c4b746f9e7408de3155f7d7aa62cd1b">ExtractTerms</a> (System.Collections.Generic.ISet&lt; <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a> &gt; terms)</td></tr>
<tr class="memdesc:a4c4b746f9e7408de3155f7d7aa62cd1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: adds all terms occuring in this query to the terms set. Only works if this query is in its <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_query.html#a2d958fad1e512fc8cbe05f68543556ab">rewritten</a> form. <a href="#a4c4b746f9e7408de3155f7d7aa62cd1b"></a><br/></td></tr>
<tr class="separator:a4c4b746f9e7408de3155f7d7aa62cd1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab714b7a512e0e2aea6f63964a30462c2"><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_filtered_query.html#ab714b7a512e0e2aea6f63964a30462c2">ToString</a> (System.String s)</td></tr>
<tr class="memdesc:ab714b7a512e0e2aea6f63964a30462c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints a user-readable version of this query. <a href="#ab714b7a512e0e2aea6f63964a30462c2"></a><br/></td></tr>
<tr class="separator:ab714b7a512e0e2aea6f63964a30462c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa240a2b86f80a925369057d6655a0cfe"><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_filtered_query.html#aa240a2b86f80a925369057d6655a0cfe">Equals</a> (System.Object o)</td></tr>
<tr class="memdesc:aa240a2b86f80a925369057d6655a0cfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true iff <code>o</code> is equal to this. <a href="#aa240a2b86f80a925369057d6655a0cfe"></a><br/></td></tr>
<tr class="separator:aa240a2b86f80a925369057d6655a0cfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae666f02fba429471a73f70bc13bcc1b2"><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_filtered_query.html#ae666f02fba429471a73f70bc13bcc1b2">GetHashCode</a> ()</td></tr>
<tr class="memdesc:ae666f02fba429471a73f70bc13bcc1b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a hash code value for this object. <a href="#ae666f02fba429471a73f70bc13bcc1b2"></a><br/></td></tr>
<tr class="separator:ae666f02fba429471a73f70bc13bcc1b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_query')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Lucene.Net.Search.Query</a></td></tr>
<tr class="memitem:a1e815cb670dec850ff74001b507fdf77 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><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_query.html#a1e815cb670dec850ff74001b507fdf77">ToString</a> ()</td></tr>
<tr class="memdesc:a1e815cb670dec850ff74001b507fdf77 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints a query to a string. <a href="#a1e815cb670dec850ff74001b507fdf77"></a><br/></td></tr>
<tr class="separator:a1e815cb670dec850ff74001b507fdf77 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a723b98d56f3442fa67eba0d4c92b943c inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html">Weight</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#a723b98d56f3442fa67eba0d4c92b943c">Weight</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html">Searcher</a> searcher)</td></tr>
<tr class="memdesc:a723b98d56f3442fa67eba0d4c92b943c inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: Constructs and initializes a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a> for a top-level query. <a href="#a723b98d56f3442fa67eba0d4c92b943c"></a><br/></td></tr>
<tr class="separator:a723b98d56f3442fa67eba0d4c92b943c inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75af5b3a52be8d47449c807bade97838 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#a75af5b3a52be8d47449c807bade97838">Combine</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>[] queries)</td></tr>
<tr class="memdesc:a75af5b3a52be8d47449c807bade97838 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: called when re-writing queries under <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_multi_searcher.html" title="Implements search over a set of Searchables.">MultiSearcher</a>. <a href="#a75af5b3a52be8d47449c807bade97838"></a><br/></td></tr>
<tr class="separator:a75af5b3a52be8d47449c807bade97838 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61ccd3cc51e811a537f7929e98302fd3 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Similarity</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#a61ccd3cc51e811a537f7929e98302fd3">GetSimilarity</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html">Searcher</a> searcher)</td></tr>
<tr class="memdesc:a61ccd3cc51e811a537f7929e98302fd3 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: Returns the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html" title="Expert: Scoring API. Subclasses implement search scoring.">Similarity</a> implementation to be used for this query. Subclasses may override this method to specify their own <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html" title="Expert: Scoring API. Subclasses implement search scoring.">Similarity</a> implementation, perhaps one that delegates through that of the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html" title="An abstract base class for search implementations. Implements the main search methods.">Searcher</a>. By default the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html" title="An abstract base class for search implementations. Implements the main search methods.">Searcher</a>'s <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html" title="Expert: Scoring API. Subclasses implement search scoring.">Similarity</a> implementation is returned. <a href="#a61ccd3cc51e811a537f7929e98302fd3"></a><br/></td></tr>
<tr class="separator:a61ccd3cc51e811a537f7929e98302fd3 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa06acccee0ba99acb9f6fea24dff856d inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memItemLeft" align="right" valign="top">virtual System.Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#aa06acccee0ba99acb9f6fea24dff856d">Clone</a> ()</td></tr>
<tr class="memdesc:aa06acccee0ba99acb9f6fea24dff856d inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a clone of this query. <a href="#aa06acccee0ba99acb9f6fea24dff856d"></a><br/></td></tr>
<tr class="separator:aa06acccee0ba99acb9f6fea24dff856d inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a1966528d60f0f34294a4b1458dab1c inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><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_query.html#a4a1966528d60f0f34294a4b1458dab1c">GetHashCode</a> ()</td></tr>
<tr class="separator:a4a1966528d60f0f34294a4b1458dab1c inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99c7950ea92f8a234e46f94616170d4c inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><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_query.html#a99c7950ea92f8a234e46f94616170d4c">Equals</a> (System.Object obj)</td></tr>
<tr class="separator:a99c7950ea92f8a234e46f94616170d4c inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><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:a41fb1bb0b2f2c0e3294e8350931db23b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_query.html#a41fb1bb0b2f2c0e3294e8350931db23b">Query</a><code> [get]</code></td></tr>
<tr class="separator:a41fb1bb0b2f2c0e3294e8350931db23b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23a4534aad4074dadcbe0c7bdd579390"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html">Filter</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_query.html#a23a4534aad4074dadcbe0c7bdd579390">Filter</a><code> [get]</code></td></tr>
<tr class="separator:a23a4534aad4074dadcbe0c7bdd579390"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_class_lucene_1_1_net_1_1_search_1_1_query"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_search_1_1_query')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Lucene.Net.Search.Query</a></td></tr>
<tr class="memitem:a2a58b600e864bed65cc21815fffa0218 inherit properties_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#a2a58b600e864bed65cc21815fffa0218">Boost</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a2a58b600e864bed65cc21815fffa0218 inherit properties_class_lucene_1_1_net_1_1_search_1_1_query"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the boost for this query clause to <code>b</code>. <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html">Documents</a> matching this clause will (in addition to the normal weightings) have their score multiplied by <code>b</code>. The boost is 1.0 by default. <a href="#a2a58b600e864bed65cc21815fffa0218"></a><br/></td></tr>
<tr class="separator:a2a58b600e864bed65cc21815fffa0218 inherit properties_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_query')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Lucene.Net.Search.Query</a></td></tr>
<tr class="memitem:ac1ca86c30835f69c14785d98261be101 inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#ac1ca86c30835f69c14785d98261be101">MergeBooleanQueries</a> (params <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_query.html">BooleanQuery</a>[] queries)</td></tr>
<tr class="memdesc:ac1ca86c30835f69c14785d98261be101 inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: merges the clauses of a set of <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_query.html" title="A Query that matches documents matching boolean combinations of other queries, e.g. TermQuerys, PhraseQuerys or other BooleanQuerys. ">BooleanQuery</a>'s into a single <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_query.html" title="A Query that matches documents matching boolean combinations of other queries, e.g. TermQuerys, PhraseQuerys or other BooleanQuerys. ">BooleanQuery</a>. <a href="#ac1ca86c30835f69c14785d98261be101"></a><br/></td></tr>
<tr class="separator:ac1ca86c30835f69c14785d98261be101 inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_query"><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>A query that applies a filter to the results of another query. </p>
<p>Note: the bits are retrieved from the filter each time this query is used in a search - use a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html" title="Wraps another filter&#39;s result and caches it. The purpose is to allow filters to simply filter...">CachingWrapperFilter</a> to avoid regenerating the bits every time.</p>
<p>Created: Apr 20, 2004 8:58:29 AM</p>
<p>&lt;since&gt;1.4&lt;/since&gt; </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html" title="Wraps another filter&#39;s result and caches it. The purpose is to allow filters to simply filter...">CachingWrapperFilter</a></dd></dl>
<p>Definition at line <a class="el" href="_filtered_query_8cs_source.html#l00039">39</a> of file <a class="el" href="_filtered_query_8cs_source.html">FilteredQuery.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8a3f275553a87900c7867665cebcff83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.FilteredQuery.FilteredQuery </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>&#160;</td>
<td class="paramname"><em>query</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_filter.html">Filter</a>&#160;</td>
<td class="paramname"><em>filter</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new query which applies a filter to the results of the original query. Filter.getDocIdSet() will be called every time this query is used in a search. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">query</td><td><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> to be filtered, cannot be <code>null</code>. </td></tr>
<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 apply to query results, cannot be <code>null</code>. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_filtered_query_8cs_source.html#l00216">216</a> of file <a class="el" href="_filtered_query_8cs_source.html">FilteredQuery.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a07286244f5217f54af2418e3b1234313"></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_weight.html">Weight</a> Lucene.Net.Search.FilteredQuery.CreateWeight </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html">Searcher</a>&#160;</td>
<td class="paramname"><em>searcher</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>Returns a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a> that applies the filter to the enclosed query's <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a>. This is accomplished by overriding the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> returned by the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a>. </p>
<p>Reimplemented from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#adb579d26787d010ed599ab01a9b6adae">Lucene.Net.Search.Query</a>.</p>
<p>Definition at line <a class="el" href="_filtered_query_8cs_source.html#l00225">225</a> of file <a class="el" href="_filtered_query_8cs_source.html">FilteredQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aa240a2b86f80a925369057d6655a0cfe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Search.FilteredQuery.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>Returns true iff <code>o</code> is equal to this. </p>
<p>Definition at line <a class="el" href="_filtered_query_8cs_source.html#l00277">277</a> of file <a class="el" href="_filtered_query_8cs_source.html">FilteredQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a4c4b746f9e7408de3155f7d7aa62cd1b"></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.Search.FilteredQuery.ExtractTerms </td>
<td>(</td>
<td class="paramtype">System.Collections.Generic.ISet&lt; <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a> &gt;&#160;</td>
<td class="paramname"><em>terms</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>Expert: adds all terms occuring in this query to the terms set. Only works if this query is in its <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_query.html#a2d958fad1e512fc8cbe05f68543556ab">rewritten</a> form. </p>
<p>&lt;throws&gt; UnsupportedOperationException if this query is not yet rewritten &lt;/throws&gt; </p>
<p>Reimplemented from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#a9f47bf807320ce75a9096c983ab358d7">Lucene.Net.Search.Query</a>.</p>
<p>Definition at line <a class="el" href="_filtered_query_8cs_source.html#l00259">259</a> of file <a class="el" href="_filtered_query_8cs_source.html">FilteredQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae666f02fba429471a73f70bc13bcc1b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Search.FilteredQuery.GetHashCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a hash code value for this object. </p>
<p>Definition at line <a class="el" href="_filtered_query_8cs_source.html#l00288">288</a> of file <a class="el" href="_filtered_query_8cs_source.html">FilteredQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2d958fad1e512fc8cbe05f68543556ab"></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_query.html">Query</a> Lucene.Net.Search.FilteredQuery.Rewrite </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><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>Rewrites the wrapped query. </p>
<p>Reimplemented from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#a0d78f3423d340cf4ddbeb2db9e13d055">Lucene.Net.Search.Query</a>.</p>
<p>Definition at line <a class="el" href="_filtered_query_8cs_source.html#l00233">233</a> of file <a class="el" href="_filtered_query_8cs_source.html">FilteredQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab714b7a512e0e2aea6f63964a30462c2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override System.String Lucene.Net.Search.FilteredQuery.ToString </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>s</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>Prints a user-readable version of this query. </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#a5c948f4230c7d9d1acf3dc38551137d5">Lucene.Net.Search.Query</a>.</p>
<p>Definition at line <a class="el" href="_filtered_query_8cs_source.html#l00265">265</a> of file <a class="el" href="_filtered_query_8cs_source.html">FilteredQuery.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a23a4534aad4074dadcbe0c7bdd579390"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html">Filter</a> Lucene.Net.Search.FilteredQuery.Filter</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="_filtered_query_8cs_source.html#l00254">254</a> of file <a class="el" href="_filtered_query_8cs_source.html">FilteredQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a41fb1bb0b2f2c0e3294e8350931db23b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> Lucene.Net.Search.FilteredQuery.Query</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="_filtered_query_8cs_source.html#l00249">249</a> of file <a class="el" href="_filtered_query_8cs_source.html">FilteredQuery.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="_filtered_query_8cs_source.html">FilteredQuery.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:57 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>