| <!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.Payloads.PayloadNearQuery 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 |
|  <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 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 List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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="namespace_lucene_1_1_net_1_1_search_1_1_payloads.html">Payloads</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query.html">PayloadNearQuery</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.Payloads.PayloadNearQuery Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>This class is very similar to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_near_query.html" title="Matches spans which are near one another. One can specify slop, the maximum number of intervening unm...">Lucene.Net.Search.Spans.SpanNearQuery</a> except that it factors in the value of the payloads located at each of the positions where the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_term_spans.html" title="Expert: Public for extension only ">Lucene.Net.Search.Spans.TermSpans</a> occurs. In order to take advantage of this, you must override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a5973cd115b539d631e994fdf86021439" title="Calculate a scoring factor based on the data in the payload. Overriding implementations are responsib...">Lucene.Net.Search.Similarity.ScorePayload</a> which returns 1 by default. Payload scores are aggregated using a pluggable <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html" title="An abstract class that defines a way for Payload*Query instances to transform the cumulative effects ...">PayloadFunction</a>. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query.html#details">More...</a></p> |
| |
| <p>Inherits SpanNearQuery, and ICloneable.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query_1_1_payload_near_span_scorer.html">PayloadNearSpanScorer</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query_1_1_payload_near_span_weight.html">PayloadNearSpanWeight</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:ae31ccc4fbbc08cfb2caf314615fa369d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query.html#ae31ccc4fbbc08cfb2caf314615fa369d">PayloadNearQuery</a> (<a class="el" href="_abstract_field_8cs.html#acc785bedc86fa99fa13c32eaf059baab">SpanQuery</a>[] clauses, int slop, bool inOrder)</td></tr> |
| <tr class="separator:ae31ccc4fbbc08cfb2caf314615fa369d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a84c07065d802c5f98afb2f0ad5ec55bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query.html#a84c07065d802c5f98afb2f0ad5ec55bb">PayloadNearQuery</a> (<a class="el" href="_abstract_field_8cs.html#acc785bedc86fa99fa13c32eaf059baab">SpanQuery</a>[] clauses, int slop, bool inOrder, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html">PayloadFunction</a> function)</td></tr> |
| <tr class="separator:a84c07065d802c5f98afb2f0ad5ec55bb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a464e956d6d19971d883ac6d2d635c7ad"><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> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query.html#a464e956d6d19971d883ac6d2d635c7ad">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="separator:a464e956d6d19971d883ac6d2d635c7ad"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a92f1585f7fc470d3f5f82e5f4a65a48f"><td class="memItemLeft" align="right" valign="top">override System.Object </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query.html#a92f1585f7fc470d3f5f82e5f4a65a48f">Clone</a> ()</td></tr> |
| <tr class="separator:a92f1585f7fc470d3f5f82e5f4a65a48f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a54814c9524aae4968fd84fe1b38c164f"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query.html#a54814c9524aae4968fd84fe1b38c164f">ToString</a> (System.String field)</td></tr> |
| <tr class="separator:a54814c9524aae4968fd84fe1b38c164f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a69eb50256f2dc1b0c1baf584aefce61e"><td class="memItemLeft" align="right" valign="top">override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query.html#a69eb50256f2dc1b0c1baf584aefce61e">GetHashCode</a> ()</td></tr> |
| <tr class="separator:a69eb50256f2dc1b0c1baf584aefce61e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aab6c3cea8624d01496c97f3604c8a6ab"><td class="memItemLeft" align="right" valign="top">override bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_near_query.html#aab6c3cea8624d01496c97f3604c8a6ab">Equals</a> (System.Object obj)</td></tr> |
| <tr class="separator:aab6c3cea8624d01496c97f3604c8a6ab"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>This class is very similar to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_near_query.html" title="Matches spans which are near one another. One can specify slop, the maximum number of intervening unm...">Lucene.Net.Search.Spans.SpanNearQuery</a> except that it factors in the value of the payloads located at each of the positions where the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_term_spans.html" title="Expert: Public for extension only ">Lucene.Net.Search.Spans.TermSpans</a> occurs. </p> |
| <p>In order to take advantage of this, you must override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a5973cd115b539d631e994fdf86021439" title="Calculate a scoring factor based on the data in the payload. Overriding implementations are responsib...">Lucene.Net.Search.Similarity.ScorePayload</a> which returns 1 by default. </p> |
| <p>Payload scores are aggregated using a pluggable <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html" title="An abstract class that defines a way for Payload*Query instances to transform the cumulative effects ...">PayloadFunction</a>. </p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a5973cd115b539d631e994fdf86021439" title="Calculate a scoring factor based on the data in the payload. Overriding implementations are responsib...">Lucene.Net.Search.Similarity.ScorePayload</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_payload_near_query_8cs_source.html#l00052">52</a> of file <a class="el" href="_payload_near_query_8cs_source.html">PayloadNearQuery.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="ae31ccc4fbbc08cfb2caf314615fa369d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.Payloads.PayloadNearQuery.PayloadNearQuery </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="_abstract_field_8cs.html#acc785bedc86fa99fa13c32eaf059baab">SpanQuery</a>[] </td> |
| <td class="paramname"><em>clauses</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>slop</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>inOrder</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_payload_near_query_8cs_source.html#l00057">57</a> of file <a class="el" href="_payload_near_query_8cs_source.html">PayloadNearQuery.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a84c07065d802c5f98afb2f0ad5ec55bb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.Payloads.PayloadNearQuery.PayloadNearQuery </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="_abstract_field_8cs.html#acc785bedc86fa99fa13c32eaf059baab">SpanQuery</a>[] </td> |
| <td class="paramname"><em>clauses</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>slop</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>inOrder</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_payloads_1_1_payload_function.html">PayloadFunction</a> </td> |
| <td class="paramname"><em>function</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_payload_near_query_8cs_source.html#l00061">61</a> of file <a class="el" href="_payload_near_query_8cs_source.html">PayloadNearQuery.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a92f1585f7fc470d3f5f82e5f4a65a48f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.Object Lucene.Net.Search.Payloads.PayloadNearQuery.Clone </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="_payload_near_query_8cs_source.html#l00072">72</a> of file <a class="el" href="_payload_near_query_8cs_source.html">PayloadNearQuery.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a464e956d6d19971d883ac6d2d635c7ad"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <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.Payloads.PayloadNearQuery.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> </td> |
| <td class="paramname"><em>searcher</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_payload_near_query_8cs_source.html#l00067">67</a> of file <a class="el" href="_payload_near_query_8cs_source.html">PayloadNearQuery.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aab6c3cea8624d01496c97f3604c8a6ab"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override bool Lucene.Net.Search.Payloads.PayloadNearQuery.Equals </td> |
| <td>(</td> |
| <td class="paramtype">System.Object </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="_payload_near_query_8cs_source.html#l00120">120</a> of file <a class="el" href="_payload_near_query_8cs_source.html">PayloadNearQuery.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a69eb50256f2dc1b0c1baf584aefce61e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Search.Payloads.PayloadNearQuery.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="_payload_near_query_8cs_source.html#l00110">110</a> of file <a class="el" href="_payload_near_query_8cs_source.html">PayloadNearQuery.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a54814c9524aae4968fd84fe1b38c164f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Search.Payloads.PayloadNearQuery.ToString </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>field</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_payload_near_query_8cs_source.html#l00086">86</a> of file <a class="el" href="_payload_near_query_8cs_source.html">PayloadNearQuery.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Search/Payloads/<a class="el" href="_payload_near_query_8cs_source.html">PayloadNearQuery.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:58 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
