Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_search_1_1_terms_filter.html
blob: c25c87357602f2bc9fea5ac036a5350d93999611 [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.TermsFilter 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_terms_filter.html">TermsFilter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_terms_filter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.TermsFilter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A filter that contains multiple terms.
<a href="class_lucene_1_1_net_1_1_search_1_1_terms_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="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6a125791855bcdadc9a16f8bd06005be"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_terms_filter.html#a6a125791855bcdadc9a16f8bd06005be">AddTerm</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a> term)</td></tr>
<tr class="memdesc:a6a125791855bcdadc9a16f8bd06005be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a term to the set. <a href="#a6a125791855bcdadc9a16f8bd06005be"></a><br/></td></tr>
<tr class="separator:a6a125791855bcdadc9a16f8bd06005be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7eb768c6a4835a226520a6db07c5d85"><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_terms_filter.html#aa7eb768c6a4835a226520a6db07c5d85">GetDocIdSet</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:aa7eb768c6a4835a226520a6db07c5d85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <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>. <a href="#aa7eb768c6a4835a226520a6db07c5d85"></a><br/></td></tr>
<tr class="separator:aa7eb768c6a4835a226520a6db07c5d85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3c921d04f230f0522696bd4c52ac4c4"><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_terms_filter.html#af3c921d04f230f0522696bd4c52ac4c4">Equals</a> (Object obj)</td></tr>
<tr class="separator:af3c921d04f230f0522696bd4c52ac4c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a939c5736de4afcb247ddf2edc98e6358"><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_terms_filter.html#a939c5736de4afcb247ddf2edc98e6358">GetHashCode</a> ()</td></tr>
<tr class="separator:a939c5736de4afcb247ddf2edc98e6358"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81cebf824693e0a7362953b028874532"><td class="memItemLeft" align="right" valign="top">override string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_terms_filter.html#a81cebf824693e0a7362953b028874532">ToString</a> ()</td></tr>
<tr class="separator:a81cebf824693e0a7362953b028874532"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a6c4ef19aba717527b4901edf3f037be5"><td class="memItemLeft" align="right" valign="top">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="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_terms_filter.html#a6c4ef19aba717527b4901edf3f037be5">terms</a> = new SortedSet&lt;<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a>&gt;()</td></tr>
<tr class="memdesc:a6c4ef19aba717527b4901edf3f037be5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The set of terms for this filter. <a href="#a6c4ef19aba717527b4901edf3f037be5"></a><br/></td></tr>
<tr class="separator:a6c4ef19aba717527b4901edf3f037be5"><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 filter that contains multiple terms. </p>
<p>Definition at line <a class="el" href="_queries_2_terms_filter_8cs_source.html#l00031">31</a> of file <a class="el" href="_queries_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6a125791855bcdadc9a16f8bd06005be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.TermsFilter.AddTerm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a>&#160;</td>
<td class="paramname"><em>term</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a term to the set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">term</td><td>The term to add.</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_queries_2_terms_filter_8cs_source.html#l00042">42</a> of file <a class="el" href="_queries_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af3c921d04f230f0522696bd4c52ac4c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Search.TermsFilter.Equals </td>
<td>(</td>
<td class="paramtype">Object&#160;</td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_queries_2_terms_filter_8cs_source.html#l00075">75</a> of file <a class="el" href="_queries_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aa7eb768c6a4835a226520a6db07c5d85"></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.TermsFilter.GetDocIdSet </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>Get the <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>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Applcible reader.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The set.</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="_queries_2_terms_filter_8cs_source.html#l00052">52</a> of file <a class="el" href="_queries_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a939c5736de4afcb247ddf2edc98e6358"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Search.TermsFilter.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="_queries_2_terms_filter_8cs_source.html#l00090">90</a> of file <a class="el" href="_queries_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a81cebf824693e0a7362953b028874532"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override string Lucene.Net.Search.TermsFilter.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="_queries_2_terms_filter_8cs_source.html#l00100">100</a> of file <a class="el" href="_queries_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a6c4ef19aba717527b4901edf3f037be5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ISet&lt;<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a>&gt; Lucene.Net.Search.TermsFilter.terms = new SortedSet&lt;<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a>&gt;()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The set of terms for this filter. </p>
<p>Definition at line <a class="el" href="_queries_2_terms_filter_8cs_source.html#l00036">36</a> of file <a class="el" href="_queries_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Queries/<a class="el" href="_queries_2_terms_filter_8cs_source.html">TermsFilter.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>