Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_documents_1_1_number_tools.html
blob: 1405554cd1d83acfc89393b5a29bc746dfd927e3 [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.Documents.NumberTools 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_documents.html">Documents</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_number_tools.html">NumberTools</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_lucene_1_1_net_1_1_documents_1_1_number_tools-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Documents.NumberTools Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides support for converting longs to Strings, and back again. The strings are structured so that lexicographic sorting order is preserved.
<a href="class_lucene_1_1_net_1_1_documents_1_1_number_tools.html#details">More...</a></p>
<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:aec390b66c051d7d9df81f5c485d5dc3a"><td class="memItemLeft" align="right" valign="top">static System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_number_tools.html#aec390b66c051d7d9df81f5c485d5dc3a">LongToString</a> (long l)</td></tr>
<tr class="memdesc:aec390b66c051d7d9df81f5c485d5dc3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a long to a String suitable for indexing. <a href="#aec390b66c051d7d9df81f5c485d5dc3a"></a><br/></td></tr>
<tr class="separator:aec390b66c051d7d9df81f5c485d5dc3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1588fa68ff59ffec383f799598fcdc4"><td class="memItemLeft" align="right" valign="top">static long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_number_tools.html#ab1588fa68ff59ffec383f799598fcdc4">StringToLong</a> (System.String str)</td></tr>
<tr class="memdesc:ab1588fa68ff59ffec383f799598fcdc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a String that was returned by LongToString back to a long. <a href="#ab1588fa68ff59ffec383f799598fcdc4"></a><br/></td></tr>
<tr class="separator:ab1588fa68ff59ffec383f799598fcdc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6c199edd8da9608cf73944ce405cf6b"><td class="memItemLeft" align="right" valign="top">static System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_number_tools.html#ad6c199edd8da9608cf73944ce405cf6b">ToString</a> (long lval)</td></tr>
<tr class="separator:ad6c199edd8da9608cf73944ce405cf6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b3d14a66ca8bd7baa39aa82ae81f424"><td class="memItemLeft" align="right" valign="top">static long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_number_tools.html#a9b3d14a66ca8bd7baa39aa82ae81f424">ToLong</a> (System.String t)</td></tr>
<tr class="separator:a9b3d14a66ca8bd7baa39aa82ae81f424"><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-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:ac1b90972753bd8869ea5aef8b179b4f9"><td class="memItemLeft" align="right" valign="top">static readonly System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_number_tools.html#ac1b90972753bd8869ea5aef8b179b4f9">MIN_STRING_VALUE</a> = NEGATIVE_PREFIX + &quot;0000000000000&quot;</td></tr>
<tr class="memdesc:ac1b90972753bd8869ea5aef8b179b4f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to longToString(Long.MIN_VALUE) <a href="#ac1b90972753bd8869ea5aef8b179b4f9"></a><br/></td></tr>
<tr class="separator:ac1b90972753bd8869ea5aef8b179b4f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0321e2bed955de364cef01e655dcfedd"><td class="memItemLeft" align="right" valign="top">static readonly System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_number_tools.html#a0321e2bed955de364cef01e655dcfedd">MAX_STRING_VALUE</a> = POSITIVE_PREFIX + &quot;1y2p0ij32e8e7&quot;</td></tr>
<tr class="memdesc:a0321e2bed955de364cef01e655dcfedd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equivalent to longToString(Long.MAX_VALUE) <a href="#a0321e2bed955de364cef01e655dcfedd"></a><br/></td></tr>
<tr class="separator:a0321e2bed955de364cef01e655dcfedd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fea5a789fdb9a4dc14ae7a35a01b63d"><td class="memItemLeft" align="right" valign="top">static readonly int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_number_tools.html#a4fea5a789fdb9a4dc14ae7a35a01b63d">STR_SIZE</a> = MIN_STRING_VALUE.Length</td></tr>
<tr class="memdesc:a4fea5a789fdb9a4dc14ae7a35a01b63d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The length of (all) strings returned by LongToString <a href="#a4fea5a789fdb9a4dc14ae7a35a01b63d"></a><br/></td></tr>
<tr class="separator:a4fea5a789fdb9a4dc14ae7a35a01b63d"><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>Provides support for converting longs to Strings, and back again. The strings are structured so that lexicographic sorting order is preserved. </p>
<p>That is, if l1 is less than l2 for any two longs l1 and l2, then NumberTools.longToString(l1) is lexicographically less than NumberTools.longToString(l2). (Similarly for "greater than" and "equals".)</p>
<p>This class handles <b>all</b> long values (unlike <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_field.html" title="Provides support for converting dates to strings and vice-versa. The strings are structured so that l...">Lucene.Net.Documents.DateField</a>).</p>
<p>&lt;deprecated&gt; For new indexes use <a class="el" href="_numeric_range_query_8cs.html#a35ee450e1da1e0bf32b70e5018cc9e5e">NumericUtils</a> instead, which provides a sortable binary representation (prefix encoded) of numeric values. To index and efficiently query numeric values use <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html" title="This class provides a Field that enables indexing of numeric values for efficient range filtering and...">NumericField</a> and NumericRangeQuery{T}. This class is included for use with existing indices and will be removed in a future release (possibly <a class="el" href="namespace_lucene.html">Lucene</a> 4.0). &lt;/deprecated&gt; </p>
<p>Definition at line <a class="el" href="_number_tools_8cs_source.html#l00049">49</a> of file <a class="el" href="_number_tools_8cs_source.html">NumberTools.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aec390b66c051d7d9df81f5c485d5dc3a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static System.String Lucene.Net.Documents.NumberTools.LongToString </td>
<td>(</td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>l</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>Converts a long to a String suitable for indexing.</p>
<p>Definition at line <a class="el" href="_number_tools_8cs_source.html#l00078">78</a> of file <a class="el" href="_number_tools_8cs_source.html">NumberTools.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab1588fa68ff59ffec383f799598fcdc4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static long Lucene.Net.Documents.NumberTools.StringToLong </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>str</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>Converts a String that was returned by LongToString back to a long. </p>
<p>&lt;throws&gt; IllegalArgumentException &lt;/throws&gt; </p>
<p>if the input is null </p>
<p>&lt;throws&gt; NumberFormatException &lt;/throws&gt; </p>
<p>if the input does not parse (it was not a String returned by longToString()). </p>
<p>Definition at line <a class="el" href="_number_tools_8cs_source.html#l00125">125</a> of file <a class="el" href="_number_tools_8cs_source.html">NumberTools.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a9b3d14a66ca8bd7baa39aa82ae81f424"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static long Lucene.Net.Documents.NumberTools.ToLong </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>t</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>Definition at line <a class="el" href="_number_tools_8cs_source.html#l00208">208</a> of file <a class="el" href="_number_tools_8cs_source.html">NumberTools.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ad6c199edd8da9608cf73944ce405cf6b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static System.String Lucene.Net.Documents.NumberTools.ToString </td>
<td>(</td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>lval</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>Definition at line <a class="el" href="_number_tools_8cs_source.html#l00184">184</a> of file <a class="el" href="_number_tools_8cs_source.html">NumberTools.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a0321e2bed955de364cef01e655dcfedd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly System.String Lucene.Net.Documents.NumberTools.MAX_STRING_VALUE = POSITIVE_PREFIX + &quot;1y2p0ij32e8e7&quot;</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>Equivalent to longToString(Long.MAX_VALUE)</p>
<p>Definition at line <a class="el" href="_number_tools_8cs_source.html#l00069">69</a> of file <a class="el" href="_number_tools_8cs_source.html">NumberTools.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ac1b90972753bd8869ea5aef8b179b4f9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly System.String Lucene.Net.Documents.NumberTools.MIN_STRING_VALUE = NEGATIVE_PREFIX + &quot;0000000000000&quot;</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>Equivalent to longToString(Long.MIN_VALUE)</p>
<p>Definition at line <a class="el" href="_number_tools_8cs_source.html#l00062">62</a> of file <a class="el" href="_number_tools_8cs_source.html">NumberTools.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a4fea5a789fdb9a4dc14ae7a35a01b63d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly int Lucene.Net.Documents.NumberTools.STR_SIZE = MIN_STRING_VALUE.Length</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>The length of (all) strings returned by LongToString</p>
<p>Definition at line <a class="el" href="_number_tools_8cs_source.html#l00075">75</a> of file <a class="el" href="_number_tools_8cs_source.html">NumberTools.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Document/<a class="el" href="_number_tools_8cs_source.html">NumberTools.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:49 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>