blob: 15eb113a3f7857d20264744d0342e44c8edf2db1 [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: contrib/Spatial/Prefix/RecursivePrefixTreeFilter.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_3a8d697be1e2feab9f01acc78e9570fb.html">contrib</a></li><li class="navelem"><a class="el" href="dir_aa809726ac61f61d2abe128b5a67bd02.html">Spatial</a></li><li class="navelem"><a class="el" href="dir_afebd260865ff8a48f2840d89f96f08a.html">Prefix</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">RecursivePrefixTreeFilter.cs</div> </div>
</div><!--header-->
<div class="contents">
<a href="_recursive_prefix_tree_filter_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;<span class="keyword">using</span> System.Collections.Generic;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">using</span> System.Diagnostics;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">using</span> Lucene.Net.Search;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">using</span> Lucene.Net.Spatial.Prefix.Tree;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">using</span> Lucene.Net.Spatial.Util;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">using</span> Lucene.Net.Util;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">using</span> Spatial4n.Core.Shapes;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span>Lucene.Net.Spatial.Prefix</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html"> 36</a></span>&#160; <span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html" title="Performs a spatial intersection filter against a field indexed with SpatialPrefixTree, a Trie. SPT yields terms (grids) at length 1 and at greater lengths corresponding to greater precisions. This filter recursively traverses each grid length and uses methods on Shape to efficiently know that all points at a prefix fit in the shape or not to either short-circuit unnecessary traversals or to efficiently load all enclosed points. ">RecursivePrefixTreeFilter</a> : <a class="code" href="class_lucene_1_1_net_1_1_search_1_1_filter.html" title="Abstract base class for restricting which documents may be returned during searching.">Filter</a></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="comment">/* TODOs for future:</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">Can a polygon query shape be optimized / made-simpler at recursive depths (e.g. intersection of shape + cell box)</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">RE &quot;scan&quot; threshold:</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment">// IF configured to do so, we could use term.freq() as an estimate on the number of places at this depth. OR, perhaps</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">// make estimates based on the total known term count at this level?</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">if (!scan) {</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> //Make some estimations on how many points there are at this level and how few there would need to be to set</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> // !scan to false.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> long termsThreshold = (long) estimateNumberIndexedTerms(cell.length(),queryShape.getDocFreqExpenseThreshold(cell));</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> long thisOrd = termsEnum.ord();</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> scan = (termsEnum.seek(thisOrd+termsThreshold+1) == TermsEnum.SeekStatus.END</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> || !cell.contains(termsEnum.term()));</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> termsEnum.seek(thisOrd);//return to last position</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment">}</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">*/</span></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; <span class="keyword">private</span> readonly String fieldName;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">private</span> readonly <a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_spatial_prefix_tree.html" title="A spatial Prefix Tree, or Trie, which decomposes shapes into prefixed strings at variable lengths cor...">SpatialPrefixTree</a> grid;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">private</span> readonly Shape queryShape;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">private</span> readonly <span class="keywordtype">int</span> prefixGridScanLevel;<span class="comment">//at least one less than grid.getMaxLevels()</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">private</span> readonly <span class="keywordtype">int</span> detailLevel;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html#a66a1e1b441b18d86ca82ca64fbf4ebfb"> 63</a></span>&#160; <span class="keyword">public</span> <a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html" title="Performs a spatial intersection filter against a field indexed with SpatialPrefixTree, a Trie. SPT yields terms (grids) at length 1 and at greater lengths corresponding to greater precisions. This filter recursively traverses each grid length and uses methods on Shape to efficiently know that all points at a prefix fit in the shape or not to either short-circuit unnecessary traversals or to efficiently load all enclosed points. ">RecursivePrefixTreeFilter</a>(String fieldName, <a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_spatial_prefix_tree.html" title="A spatial Prefix Tree, or Trie, which decomposes shapes into prefixed strings at variable lengths cor...">SpatialPrefixTree</a> grid, Shape queryShape, <span class="keywordtype">int</span> prefixGridScanLevel,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">int</span> detailLevel)</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; this.fieldName = fieldName;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; this.grid = grid;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; this.queryShape = queryShape;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; this.prefixGridScanLevel = Math.Max(1, Math.Min(prefixGridScanLevel, grid.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_spatial_prefix_tree.html#a4ec99271a2249f0e0ba614ef24247da7">GetMaxLevels</a>() - 1));</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; this.detailLevel = detailLevel;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; Debug.Assert(detailLevel &lt;= grid.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_spatial_prefix_tree.html#a4ec99271a2249f0e0ba614ef24247da7">GetMaxLevels</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;</div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html#ac5fbc39900db92d8650a2041d4e8d54b"> 74</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_doc_id_set.html" title="A DocIdSet contains a set of doc ids. Implementing classes must only implement Iterator to provide ac...">DocIdSet</a> GetDocIdSet(Index.IndexReader reader <span class="comment">/*, Bits acceptDocs*/</span>)</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; var bits = <span class="keyword">new</span> <a class="code" href="_field_cache_terms_filter_8cs.html#a39e4630d91e4f7fc118eb51aa4d221a0">OpenBitSet</a>(reader.MaxDoc);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; var terms = <span class="keyword">new</span> <a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_enum_compatibility.html" title="Wraps Lucene 3 TermEnum to make it look like a Lucene 4 TermsEnum SOLR-2155">TermsEnumCompatibility</a>(reader, fieldName);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; var term = terms.Next();</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">if</span> (term == null)</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">return</span> null;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html">Node</a> scanCell = null;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">//cells is treated like a stack. LinkedList conveniently has bulk add to beginning. It&#39;s in sorted order so that we</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="comment">// always advance forward through the termsEnum index.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; var cells = <span class="keyword">new</span> LinkedList&lt;Node&gt;(</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; grid.GetWorldNode().GetSubCells(queryShape));</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="comment">//This is a recursive algorithm that starts with one or more &quot;big&quot; cells, and then recursively dives down into the</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="comment">// first such cell that intersects with the query shape. It&#39;s a depth first traversal because we don&#39;t move onto</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="comment">// the next big cell (breadth) until we&#39;re completely done considering all smaller cells beneath it. For a given</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">// cell, if it&#39;s *within* the query shape then we can conveniently short-circuit the depth traversal and</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="comment">// grab all documents assigned to this cell/term. For an intersection of the cell and query shape, we either</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="comment">// recursively step down another grid level or we decide heuristically (via prefixGridScanLevel) that there aren&#39;t</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="comment">// that many points, and so we scan through all terms within this cell (i.e. the term starts with the cell&#39;s term),</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="comment">// seeing which ones are within the query shape.</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">while</span> (cells.Count &gt; 0)</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; {</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html">Node</a> cell = cells.First.Value; cells.RemoveFirst();</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; var cellTerm = cell.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html#a390f1795a9c39889cbd96752e5a4f1b3">GetTokenString</a>();</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; var seekStat = terms.Seek(cellTerm);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordflow">if</span> (seekStat == <a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_enum_compatibility.html" title="Wraps Lucene 3 TermEnum to make it look like a Lucene 4 TermsEnum SOLR-2155">TermsEnumCompatibility</a>.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_enum_compatibility.html#a616f1bf03b92f0da971cffc742f98577">SeekStatus</a>.END)</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordflow">if</span> (seekStat == <a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_enum_compatibility.html" title="Wraps Lucene 3 TermEnum to make it look like a Lucene 4 TermsEnum SOLR-2155">TermsEnumCompatibility</a>.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_enum_compatibility.html#a616f1bf03b92f0da971cffc742f98577">SeekStatus</a>.NOT_FOUND)</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">continue</span>;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordflow">if</span> (cell.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html#adc757453b634ca2af407f863d7de4265">GetLevel</a>() == detailLevel || cell.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html#a954b33a23b744cd75a689ef04918d91e">IsLeaf</a>())</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; {</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; terms.Docs(bits);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; }</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; {<span class="comment">//any other intersection</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="comment">//If the next indexed term is the leaf marker, then add all of them</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; var nextCellTerm = terms.Next();</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; Debug.Assert(nextCellTerm.Text.StartsWith(cellTerm));</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; scanCell = grid.GetNode(nextCellTerm.Text, scanCell);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordflow">if</span> (scanCell.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html#a954b33a23b744cd75a689ef04918d91e">IsLeaf</a>())</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; {</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; terms.Docs(bits);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; term = terms.Next();<span class="comment">//move pointer to avoid potential redundant addDocs() below</span></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;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="comment">//Decide whether to continue to divide &amp; conquer, or whether it&#39;s time to scan through terms beneath this cell.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="comment">// Scanning is a performance optimization trade-off.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">bool</span> scan = cell.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html#adc757453b634ca2af407f863d7de4265">GetLevel</a>() &gt;= prefixGridScanLevel;<span class="comment">//simple heuristic</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keywordflow">if</span> (!scan)</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; {</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="comment">//Divide &amp; conquer</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; var lst = cell.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html#abe9f033016b4974e2dcb7cc156d29e4c">GetSubCells</a>(queryShape);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordflow">for</span> (var i = lst.Count - 1; i &gt;= 0; i--) <span class="comment">//add to beginning</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; {</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; cells.AddFirst(lst[i]);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; }</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; }</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; {</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="comment">//Scan through all terms within this cell to see if they are within the queryShape. No seek()s.</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordflow">for</span> (var t = terms.Term(); t != null &amp;&amp; t.Text.StartsWith(cellTerm); t = terms.Next())</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; scanCell = grid.GetNode(t.Text, scanCell);</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordtype">int</span> termLevel = scanCell.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html#adc757453b634ca2af407f863d7de4265">GetLevel</a>();</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keywordflow">if</span> (termLevel &gt; detailLevel)</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keywordflow">continue</span>;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keywordflow">if</span> (termLevel == detailLevel || scanCell.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html#a954b33a23b744cd75a689ef04918d91e">IsLeaf</a>())</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="comment">//TODO should put more thought into implications of box vs point</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; Shape cShape = termLevel == grid.GetMaxLevels() ? scanCell.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html#a293c1e10d81405a7ebcbc4f4636895dc">GetCenter</a>() : scanCell.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_tree_1_1_node.html#a0e89dbea2581b2319c23762f4d0a54ac">GetShape</a>();</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keywordflow">if</span> (queryShape.Relate(cShape) == SpatialRelation.DISJOINT)</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keywordflow">continue</span>;</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; terms.Docs(bits);</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; }<span class="comment">//term loop</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; }</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; }</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; }<span class="comment">//cell loop</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="keywordflow">return</span> bits;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; }</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"><a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html#a28dcb511733c3ae53218cd9a43f6b1cd"> 160</a></span>&#160; <span class="keyword">public</span> <span class="keyword">override</span> <span class="keywordtype">string</span> ToString()</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; {</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;GeoFilter{fieldName=&#39;&quot;</span> + fieldName + <span class="charliteral">&#39;\&#39;&#39;</span> + <span class="stringliteral">&quot;, shape=&quot;</span> + queryShape + <span class="charliteral">&#39;}&#39;</span>;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; }</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div>
<div class="line"><a name="l00165"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html#ae07ed7e449f7c53b8391beb9ae622ed7"> 165</a></span>&#160; <span class="keyword">public</span> <span class="keyword">override</span> <span class="keywordtype">bool</span> Equals(<span class="keywordtype">object</span> o)</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; {</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="keywordflow">if</span> (<span class="keyword">this</span> == o) <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; var that = o as <a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html" title="Performs a spatial intersection filter against a field indexed with SpatialPrefixTree, a Trie. SPT yields terms (grids) at length 1 and at greater lengths corresponding to greater precisions. This filter recursively traverses each grid length and uses methods on Shape to efficiently know that all points at a prefix fit in the shape or not to either short-circuit unnecessary traversals or to efficiently load all enclosed points. ">RecursivePrefixTreeFilter</a>;</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; <span class="keywordflow">if</span> (that == null) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; <span class="keywordflow">if</span> (!fieldName.Equals(that.fieldName)) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; <span class="comment">//note that we don&#39;t need to look at grid since for the same field it should be the same</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; <span class="keywordflow">if</span> (prefixGridScanLevel != that.prefixGridScanLevel) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; <span class="keywordflow">if</span> (detailLevel != that.detailLevel) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keywordflow">if</span> (!queryShape.Equals(that.queryShape)) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; }</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;</div>
<div class="line"><a name="l00181"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html#a2f8c853469111cacb4565d581a3c145e"> 181</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="l00182"></a><span class="lineno"> 182</span>&#160; {</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; <span class="keywordtype">int</span> result = fieldName.<a class="code" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html#a2f8c853469111cacb4565d581a3c145e">GetHashCode</a>();</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; result = 31 * result + queryShape.GetHashCode();</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; result = 31 * result + detailLevel;</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; <span class="keywordflow">return</span> result;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; }</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><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:44 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>