| java.lang.Object
 org.apache.lucene.document.DateTools
| DateTools | | public class DateTools (Code) | | 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.
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.
Compared to
DateField the strings generated by the methods
in this class take slightly more space, unless your selected resolution
is set to Resolution.DAY or lower.
|
| Inner Class :public static class Resolution | |
| Method Summary | |
| public static String | dateToString(Date date, Resolution resolution)
Converts a Date to a string suitable for indexing. | | public static Date | round(Date date, Resolution resolution)
Limit a date's resolution. | | public static long | round(long time, Resolution resolution)
Limit a date's resolution. | | public static Date | stringToDate(String dateString)
Converts a string produced by timeToString or
dateToString back to a time, represented as a
Date object. | | public static long | stringToTime(String dateString)
Converts a string produced by timeToString or
dateToString back to a time, represented as the
number of milliseconds since January 1, 1970, 00:00:00 GMT. | | public static String | timeToString(long time, Resolution resolution)
Converts a millisecond time to a string suitable for indexing. |
| dateToString | | public static String dateToString(Date date, Resolution resolution)(Code) | | Converts a Date to a string suitable for indexing.
Parameters:
date - the date to be converted
Parameters:
resolution - the desired resolution, seeDateTools.round(Date,DateTools.Resolution) a string in format yyyyMMddHHmmssSSS or shorter,depeding on resolution; using UTC as timezone |
| round | | public static Date round(Date date, Resolution resolution)(Code) | | Limit a date's resolution. For example, the date 2004-09-21 13:50:11
will be changed to 2004-09-01 00:00:00 when using
Resolution.MONTH.
Parameters:
resolution - The desired resolution of the date to be returned the date with all values more precise than resolutionset to 0 or 1 |
| round | | public static long round(long time, Resolution resolution)(Code) | | Limit a date's resolution. For example, the date 1095767411000
(which represents 2004-09-21 13:50:11) will be changed to
1093989600000 (2004-09-01 00:00:00) when using
Resolution.MONTH.
Parameters:
resolution - The desired resolution of the date to be returned the date with all values more precise than resolutionset to 0 or 1, expressed as milliseconds since January 1, 1970, 00:00:00 GMT |
| stringToDate | | public static Date stringToDate(String dateString) throws ParseException(Code) | | Converts a string produced by timeToString or
dateToString back to a time, represented as a
Date object.
Parameters:
dateString - the date string to be converted the parsed time as a Date object
throws:
ParseException - if dateString is not in the expected format |
| stringToTime | | public static long stringToTime(String dateString) throws ParseException(Code) | | Converts a string produced by timeToString or
dateToString back to a time, represented as the
number of milliseconds since January 1, 1970, 00:00:00 GMT.
Parameters:
dateString - the date string to be converted the number of milliseconds since January 1, 1970, 00:00:00 GMT
throws:
ParseException - if dateString is not in the expected format |
| timeToString | | public static String timeToString(long time, Resolution resolution)(Code) | | Converts a millisecond time to a string suitable for indexing.
Parameters:
time - the date expressed as milliseconds since January 1, 1970, 00:00:00 GMT
Parameters:
resolution - the desired resolution, seeDateTools.round(long,DateTools.Resolution) a string in format yyyyMMddHHmmssSSS or shorter,depeding on resolution; using UTC as timezone |
|
|