| <!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.DateField 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_field.html">DateField</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_documents_1_1_date_field-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Documents.DateField 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 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_field.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:a86fd1b71a714934812774d463b90de63"><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_field.html#a86fd1b71a714934812774d463b90de63">MIN_DATE_STRING</a> ()</td></tr> |
| <tr class="separator:a86fd1b71a714934812774d463b90de63"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a07a9c1a6b16a63778cc749b048274885"><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_field.html#a07a9c1a6b16a63778cc749b048274885">MAX_DATE_STRING</a> ()</td></tr> |
| <tr class="separator:a07a9c1a6b16a63778cc749b048274885"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af912af482583acf05cd05494d7eff39c"><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_field.html#af912af482583acf05cd05494d7eff39c">DateToString</a> (System.DateTime date)</td></tr> |
| <tr class="memdesc:af912af482583acf05cd05494d7eff39c"><td class="mdescLeft"> </td><td class="mdescRight">Converts a Date to a string suitable for indexing. <a href="#af912af482583acf05cd05494d7eff39c"></a><br/></td></tr> |
| <tr class="separator:af912af482583acf05cd05494d7eff39c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af89284657e30ef8fad6337c6363e49a1"><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_field.html#af89284657e30ef8fad6337c6363e49a1">TimeToString</a> (long time)</td></tr> |
| <tr class="memdesc:af89284657e30ef8fad6337c6363e49a1"><td class="mdescLeft"> </td><td class="mdescRight">Converts a millisecond time to a string suitable for indexing. <a href="#af89284657e30ef8fad6337c6363e49a1"></a><br/></td></tr> |
| <tr class="separator:af89284657e30ef8fad6337c6363e49a1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4cd5c5e9199526cc273d069a0a8c548e"><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_field.html#a4cd5c5e9199526cc273d069a0a8c548e">StringToTime</a> (System.String s)</td></tr> |
| <tr class="memdesc:a4cd5c5e9199526cc273d069a0a8c548e"><td class="mdescLeft"> </td><td class="mdescRight">Converts a string-encoded date into a millisecond time. <a href="#a4cd5c5e9199526cc273d069a0a8c548e"></a><br/></td></tr> |
| <tr class="separator:a4cd5c5e9199526cc273d069a0a8c548e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3cc6e043c9676a80e73e4507f92196f1"><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_field.html#a3cc6e043c9676a80e73e4507f92196f1">StringToDate</a> (System.String s)</td></tr> |
| <tr class="memdesc:a3cc6e043c9676a80e73e4507f92196f1"><td class="mdescLeft"> </td><td class="mdescRight">Converts a string-encoded date into a Date object. <a href="#a3cc6e043c9676a80e73e4507f92196f1"></a><br/></td></tr> |
| <tr class="separator:a3cc6e043c9676a80e73e4507f92196f1"><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 by date, which makes them suitable for use as field values and search terms. </p> |
| <p>Note that this class saves dates with millisecond granularity, which is bad for <a class="el" href="_query_parser_8cs.html#a75d10c703a17be3762e29a6abbf4f85b">TermRangeQuery</a> and <a class="el" href="_query_parser_8cs.html#afc61f86ed2982a0f4a99615147046083">PrefixQuery</a>, as those queries are expanded to a BooleanQuery with a potentially large number of terms when searching. Thus you might want to use <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools.html" title="Provides support for converting dates to strings and vice-versa. The strings are structured so that l...">DateTools</a> instead.</p> |
| <p>Note: dates before 1970 cannot be used, and therefore cannot be indexed when using this class. See <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools.html" title="Provides support for converting dates to strings and vice-versa. The strings are structured so that l...">DateTools</a> for an alternative without such a limitation.</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><deprecated> If you build a new index, use <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_date_tools.html" title="Provides support for converting dates to strings and vice-versa. The strings are structured so that l...">DateTools</a> or <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> instead. This class is included for use with existing indices and will be removed in a future (possibly <a class="el" href="namespace_lucene.html">Lucene</a> 4.0) </deprecated> </p> |
| |
| <p>Definition at line <a class="el" href="_date_field_8cs_source.html#l00063">63</a> of file <a class="el" href="_date_field_8cs_source.html">DateField.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="af912af482583acf05cd05494d7eff39c"></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.DateField.DateToString </td> |
| <td>(</td> |
| <td class="paramtype">System.DateTime </td> |
| <td class="paramname"><em>date</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 Date to a string suitable for indexing.</p> |
| <p><throws> RuntimeException if the date specified in the </throws> </p> |
| <p>method argument is before 1970 </p> |
| |
| <p>Definition at line <a class="el" href="_date_field_8cs_source.html#l00091">91</a> of file <a class="el" href="_date_field_8cs_source.html">DateField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a07a9c1a6b16a63778cc749b048274885"></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.DateField.MAX_DATE_STRING </td> |
| <td>(</td> |
| <td class="paramname"></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="_date_field_8cs_source.html#l00078">78</a> of file <a class="el" href="_date_field_8cs_source.html">DateField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a86fd1b71a714934812774d463b90de63"></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.DateField.MIN_DATE_STRING </td> |
| <td>(</td> |
| <td class="paramname"></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="_date_field_8cs_source.html#l00073">73</a> of file <a class="el" href="_date_field_8cs_source.html">DateField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3cc6e043c9676a80e73e4507f92196f1"></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.DateField.StringToDate </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>s</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-encoded date into a Date object. </p> |
| |
| <p>Definition at line <a class="el" href="_date_field_8cs_source.html#l00129">129</a> of file <a class="el" href="_date_field_8cs_source.html">DateField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4cd5c5e9199526cc273d069a0a8c548e"></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.DateField.StringToTime </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>s</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-encoded date into a millisecond time. </p> |
| |
| <p>Definition at line <a class="el" href="_date_field_8cs_source.html#l00124">124</a> of file <a class="el" href="_date_field_8cs_source.html">DateField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af89284657e30ef8fad6337c6363e49a1"></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.DateField.TimeToString </td> |
| <td>(</td> |
| <td class="paramtype">long </td> |
| <td class="paramname"><em>time</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 millisecond time to a string suitable for indexing.</p> |
| <p><throws> RuntimeException if the time specified in the </throws> </p> |
| <p>method argument is negative, that is, before 1970 </p> |
| |
| <p>Definition at line <a class="el" href="_date_field_8cs_source.html#l00101">101</a> of file <a class="el" href="_date_field_8cs_source.html">DateField.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_field_8cs_source.html">DateField.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> |
