| <!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.DateTools 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 |
|  <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 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 List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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_date_tools.html">DateTools</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_documents_1_1_date_tools-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Documents.DateTools Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Provides support for converting dates to strings and vice-versa. The strings are structured so that lexicographic sorting orders them by date, which makes them suitable for use as field values and search terms. |
| <a href="class_lucene_1_1_net_1_1_documents_1_1_date_tools.html#details">More...</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  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools_1_1_resolution.html">Resolution</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the time granularity. <a href="class_lucene_1_1_net_1_1_documents_1_1_date_tools_1_1_resolution.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </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:afa823264c0479cc2bc071ff187948d7f"><td class="memItemLeft" align="right" valign="top">static System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools.html#afa823264c0479cc2bc071ff187948d7f">DateToString</a> (System.DateTime date, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools_1_1_resolution.html">Resolution</a> resolution)</td></tr> |
| <tr class="memdesc:afa823264c0479cc2bc071ff187948d7f"><td class="mdescLeft"> </td><td class="mdescRight">Converts a Date to a string suitable for indexing. <a href="#afa823264c0479cc2bc071ff187948d7f"></a><br/></td></tr> |
| <tr class="separator:afa823264c0479cc2bc071ff187948d7f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a22e6d715b323df4d200ae17807c7e2ff"><td class="memItemLeft" align="right" valign="top">static System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools.html#a22e6d715b323df4d200ae17807c7e2ff">TimeToString</a> (long time, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools_1_1_resolution.html">Resolution</a> resolution)</td></tr> |
| <tr class="memdesc:a22e6d715b323df4d200ae17807c7e2ff"><td class="mdescLeft"> </td><td class="mdescRight">Converts a millisecond time to a string suitable for indexing. <a href="#a22e6d715b323df4d200ae17807c7e2ff"></a><br/></td></tr> |
| <tr class="separator:a22e6d715b323df4d200ae17807c7e2ff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8f2fe07da6090a356424ec7b5e10cec9"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools.html#a8f2fe07da6090a356424ec7b5e10cec9">StringToTime</a> (System.String dateString)</td></tr> |
| <tr class="memdesc:a8f2fe07da6090a356424ec7b5e10cec9"><td class="mdescLeft"> </td><td class="mdescRight">Converts a string produced by <code>timeToString</code> or <code>DateToString</code> back to a time, represented as the number of milliseconds since January 1, 1970, 00:00:00 GMT. <a href="#a8f2fe07da6090a356424ec7b5e10cec9"></a><br/></td></tr> |
| <tr class="separator:a8f2fe07da6090a356424ec7b5e10cec9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a01468750fb49a8cc9ef2835fd386c7d4"><td class="memItemLeft" align="right" valign="top">static System.DateTime </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools.html#a01468750fb49a8cc9ef2835fd386c7d4">StringToDate</a> (System.String dateString)</td></tr> |
| <tr class="memdesc:a01468750fb49a8cc9ef2835fd386c7d4"><td class="mdescLeft"> </td><td class="mdescRight">Converts a string produced by <code>timeToString</code> or <code>DateToString</code> back to a time, represented as a Date object. <a href="#a01468750fb49a8cc9ef2835fd386c7d4"></a><br/></td></tr> |
| <tr class="separator:a01468750fb49a8cc9ef2835fd386c7d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9c5c7b795fec7809a47337680948a000"><td class="memItemLeft" align="right" valign="top">static System.DateTime </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools.html#a9c5c7b795fec7809a47337680948a000">Round</a> (System.DateTime date, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools_1_1_resolution.html">Resolution</a> resolution)</td></tr> |
| <tr class="memdesc:a9c5c7b795fec7809a47337680948a000"><td class="mdescLeft"> </td><td class="mdescRight">Limit a date's resolution. For example, the date <code>2004-09-21 13:50:11</code> will be changed to <code>2004-09-01 00:00:00</code> when using <code>Resolution.MONTH</code>. <a href="#a9c5c7b795fec7809a47337680948a000"></a><br/></td></tr> |
| <tr class="separator:a9c5c7b795fec7809a47337680948a000"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aead3d7b4e3bdc490faa792656fd47430"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools.html#aead3d7b4e3bdc490faa792656fd47430">Round</a> (long time, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools_1_1_resolution.html">Resolution</a> resolution)</td></tr> |
| <tr class="memdesc:aead3d7b4e3bdc490faa792656fd47430"><td class="mdescLeft"> </td><td class="mdescRight">Limit a date's resolution. For example, the date <code>1095767411000</code> (which represents 2004-09-21 13:50:11) will be changed to <code>1093989600000</code> (2004-09-01 00:00:00) when using <code>Resolution.MONTH</code>. <a href="#aead3d7b4e3bdc490faa792656fd47430"></a><br/></td></tr> |
| <tr class="separator:aead3d7b4e3bdc490faa792656fd47430"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Provides support for converting dates to strings and vice-versa. The strings are structured so that lexicographic sorting orders them by date, which makes them suitable for use as field values and search terms. </p> |
| <p>This class also helps you to limit the resolution of your dates. Do not save dates with a finer resolution than you really need, as then RangeQuery and PrefixQuery will require more memory and become slower.</p> |
| <p>Compared to <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...">DateField</a> the strings generated by the methods in this class take slightly more space, unless your selected resolution is set to <code>Resolution.DAY</code> or lower.</p> |
| <p>Another approach is <a class="el" href="_numeric_range_query_8cs.html#a35ee450e1da1e0bf32b70e5018cc9e5e">NumericUtils</a>, which provides a sortable binary representation (prefix encoded) of numeric values, which date/time are. For indexing a DateTime, convert it to unix timestamp as <code>long</code> and index this as a numeric value with <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 use NumericRangeQuery{T} to query it. </p> |
| |
| <p>Definition at line <a class="el" href="_date_tools_8cs_source.html#l00047">47</a> of file <a class="el" href="_date_tools_8cs_source.html">DateTools.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="afa823264c0479cc2bc071ff187948d7f"></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.DateTools.DateToString </td> |
| <td>(</td> |
| <td class="paramtype">System.DateTime </td> |
| <td class="paramname"><em>date</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools_1_1_resolution.html">Resolution</a> </td> |
| <td class="paramname"><em>resolution</em> </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Converts a Date to a string suitable for indexing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">date</td><td>the date to be converted </td></tr> |
| <tr><td class="paramname">resolution</td><td>the desired resolution, see Round(DateTime, DateTools.Resolution) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a string in format <code>yyyyMMddHHmmssSSS</code> or shorter, depending on <code>resolution</code>; using GMT as timezone </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_date_tools_8cs_source.html#l00076">76</a> of file <a class="el" href="_date_tools_8cs_source.html">DateTools.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9c5c7b795fec7809a47337680948a000"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static System.DateTime Lucene.Net.Documents.DateTools.Round </td> |
| <td>(</td> |
| <td class="paramtype">System.DateTime </td> |
| <td class="paramname"><em>date</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools_1_1_resolution.html">Resolution</a> </td> |
| <td class="paramname"><em>resolution</em> </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Limit a date's resolution. For example, the date <code>2004-09-21 13:50:11</code> will be changed to <code>2004-09-01 00:00:00</code> when using <code>Resolution.MONTH</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">date</td><td></td></tr> |
| <tr><td class="paramname">resolution</td><td>The desired resolution of the date to be returned </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the date with all values more precise than <code>resolution</code> set to 0 or 1 </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_date_tools_8cs_source.html#l00233">233</a> of file <a class="el" href="_date_tools_8cs_source.html">DateTools.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aead3d7b4e3bdc490faa792656fd47430"></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.DateTools.Round </td> |
| <td>(</td> |
| <td class="paramtype">long </td> |
| <td class="paramname"><em>time</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools_1_1_resolution.html">Resolution</a> </td> |
| <td class="paramname"><em>resolution</em> </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Limit a date's resolution. For example, the date <code>1095767411000</code> (which represents 2004-09-21 13:50:11) will be changed to <code>1093989600000</code> (2004-09-01 00:00:00) when using <code>Resolution.MONTH</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">time</td><td>The time in milliseconds (not ticks).</td></tr> |
| <tr><td class="paramname">resolution</td><td>The desired resolution of the date to be returned </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the date with all values more precise than <code>resolution</code> set to 0 or 1, expressed as milliseconds since January 1, 1970, 00:00:00 GMT </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_date_tools_8cs_source.html#l00250">250</a> of file <a class="el" href="_date_tools_8cs_source.html">DateTools.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a01468750fb49a8cc9ef2835fd386c7d4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static System.DateTime Lucene.Net.Documents.DateTools.StringToDate </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>dateString</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 produced by <code>timeToString</code> or <code>DateToString</code> back to a time, represented as a Date object. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">dateString</td><td>the date string to be converted </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the parsed time as a Date object </dd></dl> |
| <p><throws> ParseException if <code>dateString</code> is not in the </throws> </p> |
| <p>expected format </p> |
| |
| <p>Definition at line <a class="el" href="_date_tools_8cs_source.html#l00157">157</a> of file <a class="el" href="_date_tools_8cs_source.html">DateTools.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8f2fe07da6090a356424ec7b5e10cec9"></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.DateTools.StringToTime </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>dateString</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 produced by <code>timeToString</code> or <code>DateToString</code> back to a time, represented as the number of milliseconds since January 1, 1970, 00:00:00 GMT. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">dateString</td><td>the date string to be converted </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the number of milliseconds since January 1, 1970, 00:00:00 GMT </dd></dl> |
| <p><throws> ParseException if <code>dateString</code> is not in the </throws> </p> |
| <p>expected format </p> |
| |
| <p>Definition at line <a class="el" href="_date_tools_8cs_source.html#l00140">140</a> of file <a class="el" href="_date_tools_8cs_source.html">DateTools.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a22e6d715b323df4d200ae17807c7e2ff"></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.DateTools.TimeToString </td> |
| <td>(</td> |
| <td class="paramtype">long </td> |
| <td class="paramname"><em>time</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools_1_1_resolution.html">Resolution</a> </td> |
| <td class="paramname"><em>resolution</em> </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Converts a millisecond time to a string suitable for indexing. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">time</td><td>the date expressed as milliseconds since January 1, 1970, 00:00:00 GMT </td></tr> |
| <tr><td class="paramname">resolution</td><td>the desired resolution, see Round(long, DateTools.Resolution) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a string in format <code>yyyyMMddHHmmssSSS</code> or shorter, depending on <code>resolution</code>; using GMT as timezone </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_date_tools_8cs_source.html#l00092">92</a> of file <a class="el" href="_date_tools_8cs_source.html">DateTools.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="_date_tools_8cs_source.html">DateTools.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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
