Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_search_1_1_boolean_clause.html
blob: 9f411443e381a6eae2479c5567d7a75ba81d6fe0 [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.BooleanClause 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_boolean_clause.html">BooleanClause</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<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_boolean_clause-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.BooleanClause Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A clause in a <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="class_lucene_1_1_net_1_1_search_1_1_boolean_clause.html#details">More...</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:a4b47dba34226b48f8ec7e2c60f380239"><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_boolean_clause.html#a4b47dba34226b48f8ec7e2c60f380239">BooleanClause</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query, <a class="el" href="namespace_lucene_1_1_net_1_1_search.html#a99a7442e50a0ff52bf00ddb319eb9d34">Occur</a> occur)</td></tr>
<tr class="memdesc:a4b47dba34226b48f8ec7e2c60f380239"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_clause.html" title="A clause in a BooleanQuery. ">BooleanClause</a>. <a href="#a4b47dba34226b48f8ec7e2c60f380239"></a><br/></td></tr>
<tr class="separator:a4b47dba34226b48f8ec7e2c60f380239"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf57b1efcfc74f1f54f248c5e4c30a10"><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_boolean_clause.html#adf57b1efcfc74f1f54f248c5e4c30a10">Equals</a> (System.Object o)</td></tr>
<tr class="memdesc:adf57b1efcfc74f1f54f248c5e4c30a10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if <code>o</code> is equal to this. <a href="#adf57b1efcfc74f1f54f248c5e4c30a10"></a><br/></td></tr>
<tr class="separator:adf57b1efcfc74f1f54f248c5e4c30a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3d28894c2ecda2543019664e6c5aa90"><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_boolean_clause.html#af3d28894c2ecda2543019664e6c5aa90">GetHashCode</a> ()</td></tr>
<tr class="memdesc:af3d28894c2ecda2543019664e6c5aa90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a hash code value for this object. <a href="#af3d28894c2ecda2543019664e6c5aa90"></a><br/></td></tr>
<tr class="separator:af3d28894c2ecda2543019664e6c5aa90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a4b0d95664a5a8a5f2edcf76d9ef50c"><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_boolean_clause.html#a4a4b0d95664a5a8a5f2edcf76d9ef50c">ToString</a> ()</td></tr>
<tr class="separator:a4a4b0d95664a5a8a5f2edcf76d9ef50c"><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:a9221865438d440317e03556afe0fec44"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespace_lucene_1_1_net_1_1_search.html#a99a7442e50a0ff52bf00ddb319eb9d34">Occur</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_clause.html#a9221865438d440317e03556afe0fec44">Occur</a><code> [get, set]</code></td></tr>
<tr class="separator:a9221865438d440317e03556afe0fec44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8392a0594e9c756e506e424eb34d269"><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_boolean_clause.html#aa8392a0594e9c756e506e424eb34d269">Query</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aa8392a0594e9c756e506e424eb34d269"><td class="mdescLeft">&#160;</td><td class="mdescRight">The query whose matching documents are combined by the boolean query. <a href="#aa8392a0594e9c756e506e424eb34d269"></a><br/></td></tr>
<tr class="separator:aa8392a0594e9c756e506e424eb34d269"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8732e5a2a1711dad803c623bbff8d803"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_clause.html#a8732e5a2a1711dad803c623bbff8d803">IsProhibited</a><code> [get]</code></td></tr>
<tr class="separator:a8732e5a2a1711dad803c623bbff8d803"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a130ccad1ee0bfb91c772bc85dd1e5c36"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_clause.html#a130ccad1ee0bfb91c772bc85dd1e5c36">IsRequired</a><code> [get]</code></td></tr>
<tr class="separator:a130ccad1ee0bfb91c772bc85dd1e5c36"><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 clause in a <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>. </p>
<p>Definition at line <a class="el" href="_boolean_clause_8cs_source.html#l00025">25</a> of file <a class="el" href="_boolean_clause_8cs_source.html">BooleanClause.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4b47dba34226b48f8ec7e2c60f380239"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.BooleanClause.BooleanClause </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="namespace_lucene_1_1_net_1_1_search.html#a99a7442e50a0ff52bf00ddb319eb9d34">Occur</a>&#160;</td>
<td class="paramname"><em>occur</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_clause.html" title="A clause in a BooleanQuery. ">BooleanClause</a>.</p>
<p>Definition at line <a class="el" href="_boolean_clause_8cs_source.html#l00030">30</a> of file <a class="el" href="_boolean_clause_8cs_source.html">BooleanClause.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="adf57b1efcfc74f1f54f248c5e4c30a10"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Search.BooleanClause.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 if <code>o</code> is equal to this. </p>
<p>Definition at line <a class="el" href="_boolean_clause_8cs_source.html#l00063">63</a> of file <a class="el" href="_boolean_clause_8cs_source.html">BooleanClause.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af3d28894c2ecda2543019664e6c5aa90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Search.BooleanClause.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="_boolean_clause_8cs_source.html#l00072">72</a> of file <a class="el" href="_boolean_clause_8cs_source.html">BooleanClause.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a4a4b0d95664a5a8a5f2edcf76d9ef50c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.String Lucene.Net.Search.BooleanClause.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="_boolean_clause_8cs_source.html#l00078">78</a> of file <a class="el" href="_boolean_clause_8cs_source.html">BooleanClause.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a8732e5a2a1711dad803c623bbff8d803"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Lucene.Net.Search.BooleanClause.IsProhibited</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="_boolean_clause_8cs_source.html#l00052">52</a> of file <a class="el" href="_boolean_clause_8cs_source.html">BooleanClause.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a130ccad1ee0bfb91c772bc85dd1e5c36"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Lucene.Net.Search.BooleanClause.IsRequired</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="_boolean_clause_8cs_source.html#l00057">57</a> of file <a class="el" href="_boolean_clause_8cs_source.html">BooleanClause.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a9221865438d440317e03556afe0fec44"></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="namespace_lucene_1_1_net_1_1_search.html#a99a7442e50a0ff52bf00ddb319eb9d34">Occur</a> Lucene.Net.Search.BooleanClause.Occur</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>Definition at line <a class="el" href="_boolean_clause_8cs_source.html#l00037">37</a> of file <a class="el" href="_boolean_clause_8cs_source.html">BooleanClause.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aa8392a0594e9c756e506e424eb34d269"></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.BooleanClause.Query</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 query whose matching documents are combined by the boolean query.</p>
<p>Definition at line <a class="el" href="_boolean_clause_8cs_source.html#l00046">46</a> of file <a class="el" href="_boolean_clause_8cs_source.html">BooleanClause.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="_boolean_clause_8cs_source.html">BooleanClause.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>