com.orientechnologies.lucene.builder.OLuceneDateTools Maven / Gradle / Ivy
Show all versions of orientdb-lucene Show documentation
package com.orientechnologies.lucene.builder;
import com.orientechnologies.common.log.OLogManager;
import com.orientechnologies.orient.core.util.ODateHelper;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
/**
* This utility class replace the {@link org.apache.lucene.document.DateTools} from Lucene code
* base.
*
* It uses the {@link java.util.TimeZone} defined at database level and maintains only methods
* for string conversion to {@link Date} or long value.
*
* @author frank
*/
public class OLuceneDateTools {
// indexed by format length
private static final Resolution[] RESOLUTIONS;
static {
RESOLUTIONS = new Resolution[Resolution.MILLISECOND.formatLen + 1];
for (Resolution resolution : Resolution.values()) {
RESOLUTIONS[resolution.formatLen] = resolution;
}
}
// cannot create, the class has static methods only
private OLuceneDateTools() {}
/**
* 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.
*
* @param dateString the date string to be converted
* @return the number of milliseconds since January 1, 1970, 00:00:00 GMT
* @throws ParseException if dateString is not in the expected format
*/
public static long stringToTime(String dateString) throws ParseException {
return stringToDate(dateString).getTime();
}
/**
* Converts a string produced by timeToString or dateToString back to a
* time, represented as a Date object.
*
* @param dateString the date string to be converted
* @return the parsed time as a Date object
* @throws ParseException if dateString is not in the expected format
*/
public static Date stringToDate(String dateString) throws ParseException {
try {
SimpleDateFormat format = RESOLUTIONS[dateString.length()].format();
return format.parse(dateString);
} catch (Exception e) {
OLogManager.instance()
.error(OLuceneDateTools.class, "Exception is suppressed, original exception is ", e);
//noinspection ThrowInsideCatchBlockWhichIgnoresCaughtException
throw new ParseException("Input is not a valid date string: " + dateString, 0);
}
}
/** Specifies the time granularity. */
public enum Resolution {
/** Limit a date's resolution to year granularity. */
YEAR(4),
/** Limit a date's resolution to month granularity. */
MONTH(6),
/** Limit a date's resolution to day granularity. */
DAY(8),
/** Limit a date's resolution to hour granularity. */
HOUR(10),
/** Limit a date's resolution to minute granularity. */
MINUTE(12),
/** Limit a date's resolution to second granularity. */
SECOND(14),
/** Limit a date's resolution to millisecond granularity. */
MILLISECOND(17);
private final int formatLen;
Resolution(int formatLen) {
this.formatLen = formatLen;
}
public SimpleDateFormat format() {
// formatLen 10's place: 11111111
// formatLen 1's place: 12345678901234567
SimpleDateFormat format =
new SimpleDateFormat("yyyyMMddHHmmssSSS".substring(0, formatLen), Locale.ROOT);
format.setTimeZone(ODateHelper.getDatabaseTimeZone());
return format;
}
/** this method returns the name of the resolution in lowercase (for backwards compatibility) */
@Override
public String toString() {
return super.toString().toLowerCase(Locale.ROOT);
}
}
}