blob: 59d1827da374fe6d2a0b1a4ccb776d4cfeb49778 [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.Queries.SpatialArgsParser 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_queries.html">Queries</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_queries_1_1_spatial_args_parser.html">SpatialArgsParser</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-static-methods">Static Protected Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_spatial_1_1_queries_1_1_spatial_args_parser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Spatial.Queries.SpatialArgsParser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a72c7acf829fb40795905098145c3eabb"><td class="memItemLeft" align="right" valign="top">SpatialArgs&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_queries_1_1_spatial_args_parser.html#a72c7acf829fb40795905098145c3eabb">Parse</a> (String v, SpatialContext ctx)</td></tr>
<tr class="memdesc:a72c7acf829fb40795905098145c3eabb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses a string such as "Intersects(-10,20,-8,22) distErrPct=0.025". <a href="#a72c7acf829fb40795905098145c3eabb"></a><br/></td></tr>
<tr class="separator:a72c7acf829fb40795905098145c3eabb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a66af0a3587b1680f9b6c640dbe624767"><td class="memItemLeft" align="right" valign="top">static String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_queries_1_1_spatial_args_parser.html#a66af0a3587b1680f9b6c640dbe624767">WriteSpatialArgs</a> (SpatialArgs args)</td></tr>
<tr class="memdesc:a66af0a3587b1680f9b6c640dbe624767"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes a close approximation to the parsed input format. <a href="#a66af0a3587b1680f9b6c640dbe624767"></a><br/></td></tr>
<tr class="separator:a66af0a3587b1680f9b6c640dbe624767"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab373127610531d69496769df0dafaaf2"><td class="memItemLeft" align="right" valign="top">const String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_queries_1_1_spatial_args_parser.html#ab373127610531d69496769df0dafaaf2">DIST_ERR_PCT</a> = &quot;distErrPct&quot;</td></tr>
<tr class="separator:ab373127610531d69496769df0dafaaf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbad3daad055de0a16e42a587cdf2928"><td class="memItemLeft" align="right" valign="top">const String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_queries_1_1_spatial_args_parser.html#abbad3daad055de0a16e42a587cdf2928">DIST_ERR</a> = &quot;distErr&quot;</td></tr>
<tr class="separator:abbad3daad055de0a16e42a587cdf2928"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:abd7725f09b15299e6c952e15357388c8"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_queries_1_1_spatial_args_parser.html#abd7725f09b15299e6c952e15357388c8">ReadDouble</a> (String v)</td></tr>
<tr class="separator:abd7725f09b15299e6c952e15357388c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66d0951caf0efdd4c78cd9e4c5ddc446"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_queries_1_1_spatial_args_parser.html#a66d0951caf0efdd4c78cd9e4c5ddc446">ReadBool</a> (String v, bool defaultValue)</td></tr>
<tr class="separator:a66d0951caf0efdd4c78cd9e4c5ddc446"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c8803f229329b67ea75ff441275c00d"><td class="memItemLeft" align="right" valign="top">static Dictionary&lt; String, String &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_queries_1_1_spatial_args_parser.html#a4c8803f229329b67ea75ff441275c00d">ParseMap</a> (String body)</td></tr>
<tr class="memdesc:a4c8803f229329b67ea75ff441275c00d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses "a=b c=d f" (whitespace separated) into name-value pairs. If there is no '=' as in 'f' above then it's short for f=f. <a href="#a4c8803f229329b67ea75ff441275c00d"></a><br/></td></tr>
<tr class="separator:a4c8803f229329b67ea75ff441275c00d"><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>Definition at line <a class="el" href="_spatial_args_parser_8cs_source.html#l00027">27</a> of file <a class="el" href="_spatial_args_parser_8cs_source.html">SpatialArgsParser.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a72c7acf829fb40795905098145c3eabb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SpatialArgs Lucene.Net.Spatial.Queries.SpatialArgsParser.Parse </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SpatialContext&#160;</td>
<td class="paramname"><em>ctx</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses a string such as "Intersects(-10,20,-8,22) distErrPct=0.025". </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td></td></tr>
<tr><td class="paramname">ctx</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Definition at line <a class="el" href="_spatial_args_parser_8cs_source.html#l00057">57</a> of file <a class="el" href="_spatial_args_parser_8cs_source.html">SpatialArgsParser.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a4c8803f229329b67ea75ff441275c00d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Dictionary&lt;String, String&gt; Lucene.Net.Spatial.Queries.SpatialArgsParser.ParseMap </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>body</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses "a=b c=d f" (whitespace separated) into name-value pairs. If there is no '=' as in 'f' above then it's short for f=f. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">body</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Definition at line <a class="el" href="_spatial_args_parser_8cs_source.html#l00116">116</a> of file <a class="el" href="_spatial_args_parser_8cs_source.html">SpatialArgsParser.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a66d0951caf0efdd4c78cd9e4c5ddc446"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool Lucene.Net.Spatial.Queries.SpatialArgsParser.ReadBool </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>defaultValue</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_spatial_args_parser_8cs_source.html#l00104">104</a> of file <a class="el" href="_spatial_args_parser_8cs_source.html">SpatialArgsParser.cs</a>.</p>
</div>
</div>
<a class="anchor" id="abd7725f09b15299e6c952e15357388c8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static double Lucene.Net.Spatial.Queries.SpatialArgsParser.ReadDouble </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_spatial_args_parser_8cs_source.html#l00098">98</a> of file <a class="el" href="_spatial_args_parser_8cs_source.html">SpatialArgsParser.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a66af0a3587b1680f9b6c640dbe624767"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static String Lucene.Net.Spatial.Queries.SpatialArgsParser.WriteSpatialArgs </td>
<td>(</td>
<td class="paramtype">SpatialArgs&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a close approximation to the parsed input format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Definition at line <a class="el" href="_spatial_args_parser_8cs_source.html#l00037">37</a> of file <a class="el" href="_spatial_args_parser_8cs_source.html">SpatialArgsParser.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="abbad3daad055de0a16e42a587cdf2928"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const String Lucene.Net.Spatial.Queries.SpatialArgsParser.DIST_ERR = &quot;distErr&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_spatial_args_parser_8cs_source.html#l00030">30</a> of file <a class="el" href="_spatial_args_parser_8cs_source.html">SpatialArgsParser.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab373127610531d69496769df0dafaaf2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const String Lucene.Net.Spatial.Queries.SpatialArgsParser.DIST_ERR_PCT = &quot;distErrPct&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_spatial_args_parser_8cs_source.html#l00029">29</a> of file <a class="el" href="_spatial_args_parser_8cs_source.html">SpatialArgsParser.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Spatial/Queries/<a class="el" href="_spatial_args_parser_8cs_source.html">SpatialArgsParser.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:58 for Lucene.Net by &#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>