blob: c2c630fc21ef053824aa9e7052a989947d5b55c6 [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: core/Search/Payloads/PayloadTermQuery.cs Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#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="dir_1efe588324fc547683bba4a3f1bac847.html">core</a></li><li class="navelem"><a class="el" href="dir_56f9b3c34a852b92179da152ee78b823.html">Search</a></li><li class="navelem"><a class="el" href="dir_88bea2c074665fe818c2abb880c698ea.html">Payloads</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">PayloadTermQuery.cs</div> </div>
</div><!--header-->
<div class="contents">
<a href="_payload_term_query_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* </span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * this work for additional information regarding copyright ownership.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">using</span> System;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#a2a6914ea10bbe06764856e29e5674e66"> 20</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> = Lucene.Net.Index.IndexReader;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9"> 21</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> = Lucene.Net.Index.Term;</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#a17a77b770c87cb0e7153982c4171bfcc"> 22</a></span>&#160;<span class="keyword">using</span> <a class="code" href="core_2_analysis_2_token_8cs.html#a17a77b770c87cb0e7153982c4171bfcc">TermPositions</a> = Lucene.Net.Index.TermPositions;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#aaff36a95cdad7bc1affaff3241d83f90"> 23</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_custom_score_query_8cs.html#aaff36a95cdad7bc1affaff3241d83f90">ComplexExplanation</a> = Lucene.Net.Search.ComplexExplanation;</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#aea5b3dcb7c8a52294feb57dcaa878033"> 24</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_custom_score_query_8cs.html#aea5b3dcb7c8a52294feb57dcaa878033">Explanation</a> = Lucene.Net.Search.Explanation;</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#a83f1a9bf052559c9fc4b5dc2c3d490f1"> 25</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_documents_writer_8cs.html#a83f1a9bf052559c9fc4b5dc2c3d490f1">Scorer</a> = Lucene.Net.Search.Scorer;</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#a4be53b8845ef8ff2a91031c18774a62c"> 26</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_document_8cs.html#a4be53b8845ef8ff2a91031c18774a62c">Searcher</a> = Lucene.Net.Search.Searcher;</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#a5431a3a4edd067eec50ca39b5ea99c31"> 27</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_documents_writer_8cs.html#a5431a3a4edd067eec50ca39b5ea99c31">Similarity</a> = Lucene.Net.Search.Similarity;</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#af0d29c976e72f83236dc8d0fa23aaf32"> 28</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_documents_writer_8cs.html#af0d29c976e72f83236dc8d0fa23aaf32">Weight</a> = Lucene.Net.Search.Weight;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#afc2d1c993e3e1aaca2d065feac3a558d"> 29</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_payload_near_query_8cs.html#afc2d1c993e3e1aaca2d065feac3a558d">SpanScorer</a> = Lucene.Net.Search.Spans.SpanScorer;</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#a5d2e0366eef6be5527ad6caf1eceaaf3"> 30</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_payload_span_util_8cs.html#a5d2e0366eef6be5527ad6caf1eceaaf3">SpanTermQuery</a> = Lucene.Net.Search.Spans.SpanTermQuery;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#ad47aa18db8d4f74566061d33646c955e"> 31</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_payload_near_query_8cs.html#ad47aa18db8d4f74566061d33646c955e">SpanWeight</a> = Lucene.Net.Search.Spans.SpanWeight;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="_payload_term_query_8cs.html#a0aabd06aa0934dfe3976afa1982cbbe6"> 32</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_payload_term_query_8cs.html#a0aabd06aa0934dfe3976afa1982cbbe6">TermSpans</a> = Lucene.Net.Search.Spans.TermSpans;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">namespace </span>Lucene.Net.Search.Payloads</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; [Serializable]</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html"> 50</a></span>&#160; <span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html" title="This class is very similar to Lucene.Net.Search.Spans.SpanTermQuery except that it factors in the val...">PayloadTermQuery</a>:<a class="code" href="_payload_span_util_8cs.html#a5d2e0366eef6be5527ad6caf1eceaaf3">SpanTermQuery</a></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> <a class="code" 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> <span class="keyword">function</span>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">private</span> <span class="keywordtype">bool</span> includeSpanScore;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html#a30ae1ac279133d8d9f519bc1d396d043"> 55</a></span>&#160; <span class="keyword">public</span> <a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html" title="This class is very similar to Lucene.Net.Search.Spans.SpanTermQuery except that it factors in the val...">PayloadTermQuery</a>(<a class="code" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> term, <a class="code" 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> <span class="keyword">function</span>):this(term, function, true)</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; {</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html#ac54b4531bff34f7fc7f7328089647a1b"> 59</a></span>&#160; <span class="keyword">public</span> <a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html" title="This class is very similar to Lucene.Net.Search.Spans.SpanTermQuery except that it factors in the val...">PayloadTermQuery</a>(<a class="code" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> term, <a class="code" 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> <span class="keyword">function</span>, <span class="keywordtype">bool</span> includeSpanScore):base(term)</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; {</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; this.<span class="keyword">function</span> = <span class="keyword">function</span>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; this.includeSpanScore = includeSpanScore;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html#afc12d3c36a6bccf85c13b1b7111e4ff3"> 65</a></span>&#160; <span class="keyword">public</span> <span class="keyword">override</span> <a class="code" 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> CreateWeight(<a class="code" 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> searcher)</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">return</span> <span class="keyword">new</span> PayloadTermWeight(<span class="keyword">this</span>, <span class="keyword">this</span>, searcher);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; }</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; [Serializable]</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keyword">class </span>PayloadTermWeight:<a class="code" href="_payload_near_query_8cs.html#ad47aa18db8d4f74566061d33646c955e">SpanWeight</a></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">private</span> <span class="keywordtype">void</span> InitBlock(<a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html" title="This class is very similar to Lucene.Net.Search.Spans.SpanTermQuery except that it factors in the val...">PayloadTermQuery</a> enclosingInstance)</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; {</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; this.enclosingInstance = enclosingInstance;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">private</span> PayloadTermQuery enclosingInstance;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">public</span> PayloadTermQuery Enclosing_Instance</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; {</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">get</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; {</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">return</span> enclosingInstance;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; }</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; }</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">public</span> PayloadTermWeight(PayloadTermQuery enclosingInstance, PayloadTermQuery query, <a class="code" href="_document_8cs.html#a4be53b8845ef8ff2a91031c18774a62c">Searcher</a> searcher):base(query, searcher)</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; {</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; InitBlock(enclosingInstance);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">public</span> <span class="keyword">override</span> <a class="code" href="_documents_writer_8cs.html#a83f1a9bf052559c9fc4b5dc2c3d490f1">Scorer</a> <a class="code" href="_documents_writer_8cs.html#a83f1a9bf052559c9fc4b5dc2c3d490f1">Scorer</a>(<a class="code" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, <span class="keywordtype">bool</span> scoreDocsInOrder, <span class="keywordtype">bool</span> topScorer)</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; {</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordflow">return</span> <span class="keyword">new</span> PayloadTermSpanScorer(<span class="keyword">this</span>, (<a class="code" href="_payload_term_query_8cs.html#a0aabd06aa0934dfe3976afa1982cbbe6">TermSpans</a>) internalQuery.GetSpans(reader), <span class="keyword">this</span>, similarity, reader.Norms(internalQuery.Field));</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keyword">class </span>PayloadTermSpanScorer:<a class="code" href="_payload_near_query_8cs.html#afc2d1c993e3e1aaca2d065feac3a558d">SpanScorer</a></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; {</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">private</span> <span class="keywordtype">void</span> InitBlock(PayloadTermWeight enclosingInstance)</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; {</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; this.enclosingInstance = enclosingInstance;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; }</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">private</span> PayloadTermWeight enclosingInstance;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keyword">public</span> PayloadTermWeight Enclosing_Instance</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; {</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">get</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; {</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordflow">return</span> enclosingInstance;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; }</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; }</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="comment">// TODO: is this the best way to allocate this?</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> byte[] payload = <span class="keyword">new</span> byte[256];</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> <a class="code" href="core_2_analysis_2_token_8cs.html#a17a77b770c87cb0e7153982c4171bfcc">TermPositions</a> positions;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keywordtype">float</span> payloadScore;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keywordtype">int</span> payloadsSeen;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keyword">public</span> PayloadTermSpanScorer(PayloadTermWeight enclosingInstance, <a class="code" href="_payload_term_query_8cs.html#a0aabd06aa0934dfe3976afa1982cbbe6">TermSpans</a> spans, <a class="code" href="_documents_writer_8cs.html#af0d29c976e72f83236dc8d0fa23aaf32">Weight</a> weight, <a class="code" href="_documents_writer_8cs.html#a5431a3a4edd067eec50ca39b5ea99c31">Similarity</a> similarity, byte[] norms):base(spans, weight, similarity, norms)</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; {</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; InitBlock(enclosingInstance);</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; positions = spans.Positions;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; }</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">public</span> <span class="comment">/*protected internal*/</span> <span class="keyword">override</span> <span class="keywordtype">bool</span> SetFreqCurrentDoc()</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; {</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordflow">if</span> (!more)</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; {</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; }</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; doc = spans.Doc();</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; freq = 0.0f;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; payloadScore = 0;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; payloadsSeen = 0;</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <a class="code" href="_documents_writer_8cs.html#a5431a3a4edd067eec50ca39b5ea99c31">Similarity</a> similarity1 = <a class="code" href="_documents_writer_8cs.html#a5431a3a4edd067eec50ca39b5ea99c31">Similarity</a>;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keywordflow">while</span> (more &amp;&amp; doc == spans.Doc())</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; {</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordtype">int</span> matchLength = spans.End() - spans.Start();</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; freq += similarity1.SloppyFreq(matchLength);</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; ProcessPayload(similarity1);</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; more = spans.Next(); <span class="comment">// this moves positions to the next match in this</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="comment">// document</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; }</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keywordflow">return</span> more || (freq != 0);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; }</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> ProcessPayload(<a class="code" href="_documents_writer_8cs.html#a5431a3a4edd067eec50ca39b5ea99c31">Similarity</a> similarity)</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; {</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keywordflow">if</span> (positions.IsPayloadAvailable)</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; {</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; payload = positions.GetPayload(payload, 0);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; payloadScore = Enclosing_Instance.Enclosing_Instance.function.CurrentScore(doc, Enclosing_Instance.Enclosing_Instance.internalTerm.Field, spans.Start(), spans.End(), payloadsSeen, payloadScore, similarity.ScorePayload(doc, Enclosing_Instance.Enclosing_Instance.internalTerm.Field, spans.Start(), spans.End(), payload, 0, positions.PayloadLength));</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; payloadsSeen++;</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; }</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; {</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="comment">// zero out the payload?</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; }</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; }</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keyword">public</span> <span class="keyword">override</span> <span class="keywordtype">float</span> Score()</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; {</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keywordflow">return</span> Enclosing_Instance.Enclosing_Instance.includeSpanScore?GetSpanScore() * GetPayloadScore():GetPayloadScore();</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; }</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; [System.Diagnostics.CodeAnalysis.SuppressMessage(<span class="stringliteral">&quot;Microsoft.Design&quot;</span>, <span class="stringliteral">&quot;CA1024:UsePropertiesWhereAppropriate&quot;</span>)]</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keyword">virtual</span> <span class="keywordtype">float</span> GetSpanScore()</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; {</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; <span class="keywordflow">return</span> base.Score();</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; }</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; </div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; [System.Diagnostics.CodeAnalysis.SuppressMessage(<span class="stringliteral">&quot;Microsoft.Design&quot;</span>, <span class="stringliteral">&quot;CA1024:UsePropertiesWhereAppropriate&quot;</span>)]</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keyword">virtual</span> <span class="keywordtype">float</span> GetPayloadScore()</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; {</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <span class="keywordflow">return</span> Enclosing_Instance.Enclosing_Instance.function.DocScore(doc, Enclosing_Instance.Enclosing_Instance.internalTerm.Field, payloadsSeen, payloadScore);</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; }</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; </div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keyword">override</span> <a class="code" href="_custom_score_query_8cs.html#aea5b3dcb7c8a52294feb57dcaa878033">Explanation</a> Explain(<span class="keywordtype">int</span> doc)</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; {</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; <a class="code" href="_custom_score_query_8cs.html#aaff36a95cdad7bc1affaff3241d83f90">ComplexExplanation</a> result = <span class="keyword">new</span> <a class="code" href="_custom_score_query_8cs.html#aaff36a95cdad7bc1affaff3241d83f90">ComplexExplanation</a>();</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; <a class="code" href="_custom_score_query_8cs.html#aea5b3dcb7c8a52294feb57dcaa878033">Explanation</a> nonPayloadExpl = base.Explain(doc);</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; result.AddDetail(nonPayloadExpl);</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; <span class="comment">// QUESTION: Is there a way to avoid this skipTo call? We need to know</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; <span class="comment">// whether to load the payload or not</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160; <a class="code" href="_custom_score_query_8cs.html#aea5b3dcb7c8a52294feb57dcaa878033">Explanation</a> payloadBoost = <span class="keyword">new</span> <a class="code" href="_custom_score_query_8cs.html#aea5b3dcb7c8a52294feb57dcaa878033">Explanation</a>();</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; result.AddDetail(payloadBoost);</div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; </div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; <span class="keywordtype">float</span> payloadScore = GetPayloadScore();</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; payloadBoost.Value = payloadScore;</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; <span class="comment">// GSI: I suppose we could toString the payload, but I don&#39;t think that</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; <span class="comment">// would be a good idea</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; payloadBoost.Description = <span class="stringliteral">&quot;scorePayload(...)&quot;</span>;</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; result.Value = nonPayloadExpl.Value * payloadScore;</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; result.Description = <span class="stringliteral">&quot;btq, product of:&quot;</span>;</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; result.Match = nonPayloadExpl.Value == 0?<span class="keyword">false</span>:<span class="keyword">true</span>; <span class="comment">// LUCENE-1303</span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; <span class="keywordflow">return</span> result;</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; }</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; }</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; }</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; </div>
<div class="line"><a name="l00225"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html#ac869c46824bb70495d4eee8059588e4b"> 225</a></span>&#160; <span class="keyword">public</span> <span class="keyword">override</span> <span class="keywordtype">int</span> GetHashCode()</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; {</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; <span class="keywordtype">int</span> prime = 31;</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; <span class="keywordtype">int</span> result = base.GetHashCode();</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; result = prime * result + ((<span class="keyword">function</span> == null)?0:<span class="keyword">function</span>.GetHashCode());</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; result = prime * result + (includeSpanScore?1231:1237);</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; <span class="keywordflow">return</span> result;</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; }</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; </div>
<div class="line"><a name="l00234"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html#af9ea1e2f0f4e0a5d7840c95a41caa254"> 234</a></span>&#160; <span class="keyword">public</span> <span class="keyword">override</span> <span class="keywordtype">bool</span> Equals(System.Object obj)</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; {</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; <span class="keywordflow">if</span> (<span class="keyword">this</span> == obj)</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; <span class="keywordflow">if</span> (!base.Equals(obj))</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; <span class="keywordflow">if</span> (GetType() != obj.GetType())</div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; <a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html" title="This class is very similar to Lucene.Net.Search.Spans.SpanTermQuery except that it factors in the val...">PayloadTermQuery</a> other = (<a class="code" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html" title="This class is very similar to Lucene.Net.Search.Spans.SpanTermQuery except that it factors in the val...">PayloadTermQuery</a>) obj;</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160; <span class="keywordflow">if</span> (<span class="keyword">function</span> == null)</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; {</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; <span class="keywordflow">if</span> (other.function != null)</div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; }</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span> (!<span class="keyword">function</span>.Equals(other.function))</div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; <span class="keywordflow">if</span> (includeSpanScore != other.includeSpanScore)</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160; }</div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; }</div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:46 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>