blob: 1d7a7e474ba756cdb33d22d9e4e8ebb7b2a6bab4 [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.PhraseQuery 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_phrase_query.html">PhraseQuery</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_phrase_query-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.PhraseQuery Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>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 matches documents containing a particular sequence of terms. A <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_query.html" title="A Query that matches documents containing a particular sequence of terms. A PhraseQuery is built by Q...">PhraseQuery</a> is built by QueryParser for input like <code>"new york"</code>.
<a href="class_lucene_1_1_net_1_1_search_1_1_phrase_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:ab0768d0cdfc077d6fcf2236edcbac24a"><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_phrase_query.html#ab0768d0cdfc077d6fcf2236edcbac24a">PhraseQuery</a> ()</td></tr>
<tr class="memdesc:ab0768d0cdfc077d6fcf2236edcbac24a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an empty phrase query. <a href="#ab0768d0cdfc077d6fcf2236edcbac24a"></a><br/></td></tr>
<tr class="separator:ab0768d0cdfc077d6fcf2236edcbac24a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73747b1c2a28259caf60036f80bc5ad8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_query.html#a73747b1c2a28259caf60036f80bc5ad8">Add</a> (<a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> term)</td></tr>
<tr class="memdesc:a73747b1c2a28259caf60036f80bc5ad8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a term to the end of the query phrase. The relative position of the term is the one immediately after the last term added. <a href="#a73747b1c2a28259caf60036f80bc5ad8"></a><br/></td></tr>
<tr class="separator:a73747b1c2a28259caf60036f80bc5ad8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fb49e8c456fee13c286c8a1df010625"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_query.html#a6fb49e8c456fee13c286c8a1df010625">Add</a> (<a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> term, int position)</td></tr>
<tr class="memdesc:a6fb49e8c456fee13c286c8a1df010625"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a term to the end of the query phrase. The relative position of the term within the phrase is specified explicitly. This allows e.g. phrases with more than one term at the same position or phrases with gaps (e.g. in connection with stopwords). <a href="#a6fb49e8c456fee13c286c8a1df010625"></a><br/></td></tr>
<tr class="separator:a6fb49e8c456fee13c286c8a1df010625"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c528be9ef94f3907e29430abc936b66"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a>[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_query.html#a6c528be9ef94f3907e29430abc936b66">GetTerms</a> ()</td></tr>
<tr class="memdesc:a6c528be9ef94f3907e29430abc936b66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the set of terms in this phrase. <a href="#a6c528be9ef94f3907e29430abc936b66"></a><br/></td></tr>
<tr class="separator:a6c528be9ef94f3907e29430abc936b66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2122f158f9704683c4f6897dc20367a"><td class="memItemLeft" align="right" valign="top">virtual int[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_query.html#ad2122f158f9704683c4f6897dc20367a">GetPositions</a> ()</td></tr>
<tr class="memdesc:ad2122f158f9704683c4f6897dc20367a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the relative positions of terms in this phrase. <a href="#ad2122f158f9704683c4f6897dc20367a"></a><br/></td></tr>
<tr class="separator:ad2122f158f9704683c4f6897dc20367a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a311c434e22c5ab314b32406d3ee7e731"><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_phrase_query.html#a311c434e22c5ab314b32406d3ee7e731">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:a311c434e22c5ab314b32406d3ee7e731"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: Constructs an appropriate <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> implementation for this query. <a href="#a311c434e22c5ab314b32406d3ee7e731"></a><br/></td></tr>
<tr class="separator:a311c434e22c5ab314b32406d3ee7e731"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e7b4bb6e497d4844c608ca31506da45"><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_phrase_query.html#a6e7b4bb6e497d4844c608ca31506da45">ExtractTerms</a> (System.Collections.Generic.ISet&lt; <a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> &gt; queryTerms)</td></tr>
<tr class="separator:a6e7b4bb6e497d4844c608ca31506da45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a377e77b10b4c6b2303c62bbd3ad54e70"><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_phrase_query.html#a377e77b10b4c6b2303c62bbd3ad54e70">ToString</a> (System.String f)</td></tr>
<tr class="memdesc:a377e77b10b4c6b2303c62bbd3ad54e70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints a user-readable version of this query. <a href="#a377e77b10b4c6b2303c62bbd3ad54e70"></a><br/></td></tr>
<tr class="separator:a377e77b10b4c6b2303c62bbd3ad54e70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cc1205f323e17b4dacde3257075472c"><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_phrase_query.html#a5cc1205f323e17b4dacde3257075472c">Equals</a> (System.Object o)</td></tr>
<tr class="memdesc:a5cc1205f323e17b4dacde3257075472c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true iff <code>o</code> is equal to this. <a href="#a5cc1205f323e17b4dacde3257075472c"></a><br/></td></tr>
<tr class="separator:a5cc1205f323e17b4dacde3257075472c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9e50842332271c19a72df34b17e189c"><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_phrase_query.html#ae9e50842332271c19a72df34b17e189c">GetHashCode</a> ()</td></tr>
<tr class="memdesc:ae9e50842332271c19a72df34b17e189c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a hash code value for this object. <a href="#ae9e50842332271c19a72df34b17e189c"></a><br/></td></tr>
<tr class="separator:ae9e50842332271c19a72df34b17e189c"><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:a0d78f3423d340cf4ddbeb2db9e13d055 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#a0d78f3423d340cf4ddbeb2db9e13d055">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:a0d78f3423d340cf4ddbeb2db9e13d055 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_query"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: called to re-write queries into primitive queries. For example, a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_prefix_query.html" title="A Query that matches documents containing terms with a specified prefix. A PrefixQuery is built by Qu...">PrefixQuery</a> will be rewritten into 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> that consists of TermQuerys. <a href="#a0d78f3423d340cf4ddbeb2db9e13d055"></a><br/></td></tr>
<tr class="separator:a0d78f3423d340cf4ddbeb2db9e13d055 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:ab0b42bf7038acb8464c7a31de6c1fb22"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_query.html#ab0b42bf7038acb8464c7a31de6c1fb22">Slop</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ab0b42bf7038acb8464c7a31de6c1fb22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the number of other words permitted between words in query phrase. If zero, then this is an exact phrase search. For larger values this works like a <code>WITHIN</code> or <code>NEAR</code> operator. The slop is in fact an edit-distance, where the units correspond to moves of terms in the query phrase out of position. For example, to switch the order of two words requires two moves (the first move places the words atop one another), so to permit re-orderings of phrases, the slop must be at least two. More exact matches are scored higher than sloppier matches, thus search results are sorted by exactness. The slop is zero by default, requiring exact matches. <a href="#ab0b42bf7038acb8464c7a31de6c1fb22"></a><br/></td></tr>
<tr class="separator:ab0b42bf7038acb8464c7a31de6c1fb22"><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 <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 matches documents containing a particular sequence of terms. A <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_query.html" title="A Query that matches documents containing a particular sequence of terms. A PhraseQuery is built by Q...">PhraseQuery</a> is built by QueryParser for input like <code>"new york"</code>. </p>
<p>This query may be combined with other terms or queries with 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="_phrase_query_8cs_source.html#l00035">35</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab0768d0cdfc077d6fcf2236edcbac24a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.PhraseQuery.PhraseQuery </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an empty phrase query. </p>
<p>Definition at line <a class="el" href="_phrase_query_8cs_source.html#l00044">44</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a73747b1c2a28259caf60036f80bc5ad8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Lucene.Net.Search.PhraseQuery.Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a>&#160;</td>
<td class="paramname"><em>term</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>Adds a term to the end of the query phrase. The relative position of the term is the one immediately after the last term added. </p>
<p>Definition at line <a class="el" href="_phrase_query_8cs_source.html#l00069">69</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6fb49e8c456fee13c286c8a1df010625"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Lucene.Net.Search.PhraseQuery.Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a>&#160;</td>
<td class="paramname"><em>term</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>position</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Adds a term to the end of the query phrase. The relative position of the term within the phrase is specified explicitly. This allows e.g. phrases with more than one term at the same position or phrases with gaps (e.g. in connection with stopwords). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">term</td><td></td></tr>
<tr><td class="paramname">position</td><td></td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_phrase_query_8cs_source.html#l00088">88</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a311c434e22c5ab314b32406d3ee7e731"></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.PhraseQuery.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>Expert: Constructs an appropriate <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> implementation for this query. </p>
<p>Only implemented by primitive queries, which re-write to themselves. </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="_phrase_query_8cs_source.html#l00280">280</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a5cc1205f323e17b4dacde3257075472c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Search.PhraseQuery.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="_phrase_query_8cs_source.html#l00356">356</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6e7b4bb6e497d4844c608ca31506da45"></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.PhraseQuery.ExtractTerms </td>
<td>(</td>
<td class="paramtype">System.Collections.Generic.ISet&lt; <a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> &gt;&#160;</td>
<td class="paramname"><em>queryTerms</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">
<dl class="section see"><dt>See Also</dt><dd>Lucene.Net.Search.Query.ExtractTerms(System.Collections.Generic.ISet{Term})</dd></dl>
<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="_phrase_query_8cs_source.html#l00295">295</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae9e50842332271c19a72df34b17e189c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Search.PhraseQuery.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="_phrase_query_8cs_source.html#l00365">365</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ad2122f158f9704683c4f6897dc20367a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int [] Lucene.Net.Search.PhraseQuery.GetPositions </td>
<td>(</td>
<td class="paramname"></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 the relative positions of terms in this phrase.</p>
<p>Definition at line <a class="el" href="_phrase_query_8cs_source.html#l00110">110</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6c528be9ef94f3907e29430abc936b66"></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="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> [] Lucene.Net.Search.PhraseQuery.GetTerms </td>
<td>(</td>
<td class="paramname"></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 the set of terms in this phrase. </p>
<p>Definition at line <a class="el" href="_phrase_query_8cs_source.html#l00104">104</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a377e77b10b4c6b2303c62bbd3ad54e70"></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.PhraseQuery.ToString </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>f</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="_phrase_query_8cs_source.html#l00301">301</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ab0b42bf7038acb8464c7a31de6c1fb22"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int Lucene.Net.Search.PhraseQuery.Slop</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>Sets the number of other words permitted between words in query phrase. If zero, then this is an exact phrase search. For larger values this works like a <code>WITHIN</code> or <code>NEAR</code> operator. The slop is in fact an edit-distance, where the units correspond to moves of terms in the query phrase out of position. For example, to switch the order of two words requires two moves (the first move places the words atop one another), so to permit re-orderings of phrases, the slop must be at least two. More exact matches are scored higher than sloppier matches, thus search results are sorted by exactness. The slop is zero by default, requiring exact matches. </p>
<p>Definition at line <a class="el" href="_phrase_query_8cs_source.html#l00061">61</a> of file <a class="el" href="_phrase_query_8cs_source.html">PhraseQuery.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="_phrase_query_8cs_source.html">PhraseQuery.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>