Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_shape_field_cache_distance_value_source.html
blob: 4f40d96d9f9d46c19d7ae859831980d8f5fe02ad [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_spatial.html">Spatial</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_spatial_1_1_util.html">Util</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_shape_field_cache_distance_value_source.html">ShapeFieldCacheDistanceValueSource</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_shape_field_cache_distance_value_source-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An implementation of the <a class="el" href="namespace_lucene.html">Lucene</a> ValueSource model to support spatial relevance ranking.
<a href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_shape_field_cache_distance_value_source.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html">Lucene.Net.Search.Function.ValueSource</a>.</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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_shape_field_cache_distance_value_source_1_1_cached_distance_doc_values.html">CachedDistanceDocValues</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a5086151d0148b2d3c00c3a7cddc208be"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_shape_field_cache_distance_value_source.html#a5086151d0148b2d3c00c3a7cddc208be">ShapeFieldCacheDistanceValueSource</a> (SpatialContext ctx, ShapeFieldCacheProvider&lt; Point &gt; provider, Point from)</td></tr>
<tr class="separator:a5086151d0148b2d3c00c3a7cddc208be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79c17b58d660e6ce99b54c8986a47940"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_doc_values.html">DocValues</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_shape_field_cache_distance_value_source.html#a79c17b58d660e6ce99b54c8986a47940">GetValues</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader)</td></tr>
<tr class="memdesc:a79c17b58d660e6ce99b54c8986a47940"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the DocValues used by the function query. <a href="#a79c17b58d660e6ce99b54c8986a47940"></a><br/></td></tr>
<tr class="separator:a79c17b58d660e6ce99b54c8986a47940"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ce4a6cf2fc9d2beb8a08ba2c67a10b8"><td class="memItemLeft" align="right" valign="top">override string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_shape_field_cache_distance_value_source.html#a1ce4a6cf2fc9d2beb8a08ba2c67a10b8">Description</a> ()</td></tr>
<tr class="memdesc:a1ce4a6cf2fc9d2beb8a08ba2c67a10b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">description of field, used in explain() <a href="#a1ce4a6cf2fc9d2beb8a08ba2c67a10b8"></a><br/></td></tr>
<tr class="separator:a1ce4a6cf2fc9d2beb8a08ba2c67a10b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe938c214ec040453c732a6a82c9a8c3"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_shape_field_cache_distance_value_source.html#afe938c214ec040453c732a6a82c9a8c3">Equals</a> (object o)</td></tr>
<tr class="separator:afe938c214ec040453c732a6a82c9a8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a680afd4d430fe038a70bfcfa34c1bb"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_shape_field_cache_distance_value_source.html#a4a680afd4d430fe038a70bfcfa34c1bb">GetHashCode</a> ()</td></tr>
<tr class="memdesc:a4a680afd4d430fe038a70bfcfa34c1bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Needed for possible caching of query results - used by ValueSourceQuery.GetHashCode(). <a href="#a4a680afd4d430fe038a70bfcfa34c1bb"></a><br/></td></tr>
<tr class="separator:a4a680afd4d430fe038a70bfcfa34c1bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html">Lucene.Net.Search.Function.ValueSource</a></td></tr>
<tr class="memitem:a502b061330d9e0ba6139ac58a4ffa0b9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td class="memItemLeft" align="right" valign="top">override System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a502b061330d9e0ba6139ac58a4ffa0b9">ToString</a> ()</td></tr>
<tr class="separator:a502b061330d9e0ba6139ac58a4ffa0b9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed70eaaa40d4170914f814a7ced188bc inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td class="memItemLeft" align="right" valign="top">abstract override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#aed70eaaa40d4170914f814a7ced188bc">Equals</a> (System.Object o)</td></tr>
<tr class="memdesc:aed70eaaa40d4170914f814a7ced188bc inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Needed for possible caching of query results - used by ValueSourceQuery.Equals(Object). <a href="#aed70eaaa40d4170914f814a7ced188bc"></a><br/></td></tr>
<tr class="separator:aed70eaaa40d4170914f814a7ced188bc inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An implementation of the <a class="el" href="namespace_lucene.html">Lucene</a> ValueSource model to support spatial relevance ranking. </p>
<p>Definition at line <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html#l00030">30</a> of file <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html">ShapeFieldCacheDistanceValueSource.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5086151d0148b2d3c00c3a7cddc208be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource.ShapeFieldCacheDistanceValueSource </td>
<td>(</td>
<td class="paramtype">SpatialContext&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ShapeFieldCacheProvider&lt; Point &gt;&#160;</td>
<td class="paramname"><em>provider</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Point&#160;</td>
<td class="paramname"><em>from</em>&#160;</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="_shape_field_cache_distance_value_source_8cs_source.html#l00036">36</a> of file <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html">ShapeFieldCacheDistanceValueSource.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1ce4a6cf2fc9d2beb8a08ba2c67a10b8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override string Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource.Description </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>description of field, used in explain() </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a20134fc1e0bb7739626e2434f95473ba">Lucene.Net.Search.Function.ValueSource</a>.</p>
<p>Definition at line <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html#l00092">92</a> of file <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html">ShapeFieldCacheDistanceValueSource.cs</a>.</p>
</div>
</div>
<a class="anchor" id="afe938c214ec040453c732a6a82c9a8c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource.Equals </td>
<td>(</td>
<td class="paramtype">object&#160;</td>
<td class="paramname"><em>o</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html#l00097">97</a> of file <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html">ShapeFieldCacheDistanceValueSource.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a4a680afd4d430fe038a70bfcfa34c1bb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource.GetHashCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Needed for possible caching of query results - used by ValueSourceQuery.GetHashCode().</p>
<dl class="section see"><dt>See Also</dt><dd>Object.GetHashCode()</dd></dl>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a614e97264e961aa7c769a6e592f30f09">Lucene.Net.Search.Function.ValueSource</a>.</p>
<p>Definition at line <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html#l00111">111</a> of file <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html">ShapeFieldCacheDistanceValueSource.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a79c17b58d660e6ce99b54c8986a47940"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_doc_values.html">DocValues</a> Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource.GetValues </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the DocValues used by the function query.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>the IndexReader used to read these values. If any caching is involved, that caching would also be IndexReader based. </td></tr>
</table>
</dd>
</dl>
<p>&lt;throws&gt; IOException for any error. &lt;/throws&gt; </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a4fe47158939f191400db3b71dec5a61f">Lucene.Net.Search.Function.ValueSource</a>.</p>
<p>Definition at line <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html#l00087">87</a> of file <a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html">ShapeFieldCacheDistanceValueSource.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Spatial/Util/<a class="el" href="_shape_field_cache_distance_value_source_8cs_source.html">ShapeFieldCacheDistanceValueSource.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:59 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>