Package org.apache.lucene.document
Class DateTools
java.lang.Object
org.apache.lucene.document.DateTools
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 TermRangeQuery and PrefixQuery
will require more memory and become slower.
Another approach is LongPoint, which indexes the values in sorted order. For indexing
a Date or Calendar, just get the unix timestamp as long using Date.getTime() or Calendar.getTimeInMillis() and index this as a numeric value with LongPoint and use PointRangeQuery to query it.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumSpecifies the time granularity. -
Method Summary
Modifier and TypeMethodDescriptionstatic StringdateToString(Date date, DateTools.Resolution resolution) Converts a Date to a string suitable for indexing.static longround(long time, DateTools.Resolution resolution) Limit a date's resolution.static Dateround(Date date, DateTools.Resolution resolution) Limit a date's resolution.static DatestringToDate(String dateString) Converts a string produced bytimeToStringordateToStringback to a time, represented as a Date object.static longstringToTime(String dateString) Converts a string produced bytimeToStringordateToStringback to a time, represented as the number of milliseconds since January 1, 1970, 00:00:00 GMT.static StringtimeToString(long time, DateTools.Resolution resolution) Converts a millisecond time to a string suitable for indexing.
-
Method Details
-
dateToString
Converts a Date to a string suitable for indexing.- Parameters:
date- the date to be convertedresolution- the desired resolution, seeround(Date, DateTools.Resolution)- Returns:
- a string in format
yyyyMMddHHmmssSSSor shorter, depending onresolution; using GMT as timezone
-
timeToString
Converts a millisecond time to a string suitable for indexing.- Parameters:
time- the date expressed as milliseconds since January 1, 1970, 00:00:00 GMTresolution- the desired resolution, seeround(long, DateTools.Resolution)- Returns:
- a string in format
yyyyMMddHHmmssSSSor shorter, depending onresolution; using GMT as timezone
-
stringToTime
Converts a string produced bytimeToStringordateToStringback 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- Returns:
- the number of milliseconds since January 1, 1970, 00:00:00 GMT
- Throws:
ParseException- ifdateStringis not in the expected format
-
stringToDate
Converts a string produced bytimeToStringordateToStringback to a time, represented as a Date object.- Parameters:
dateString- the date string to be converted- Returns:
- the parsed time as a Date object
- Throws:
ParseException- ifdateStringis not in the expected format
-
round
Limit a date's resolution. For example, the date2004-09-21 13:50:11will be changed to2004-09-01 00:00:00when usingResolution.MONTH.- Parameters:
resolution- The desired resolution of the date to be returned- Returns:
- the date with all values more precise than
resolutionset to 0 or 1
-
round
Limit a date's resolution. For example, the date1095767411000(which represents 2004-09-21 13:50:11) will be changed to1093989600000(2004-09-01 00:00:00) when usingResolution.MONTH.- Parameters:
resolution- The desired resolution of the date to be returned- Returns:
- the date with all values more precise than
resolutionset to 0 or 1, expressed as milliseconds since January 1, 1970, 00:00:00 GMT
-