package tim.prune.data;
+
import java.text.DateFormat;
-import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
-import java.util.Date;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
+import java.util.TimeZone;
+
/**
- * Class to hold the timestamp of a track point
- * and provide conversion functions
+ * Superclass of all timestamp implementations
*/
-public class Timestamp
+public abstract class Timestamp
{
- private boolean _valid = false;
- private long _seconds = 0L;
- private String _text = null;
- private String _timeText = null;
-
- private static final DateFormat DEFAULT_DATE_FORMAT = DateFormat.getDateTimeInstance();
+ private static final DateFormat DEFAULT_DATE_FORMAT = DateFormat.getDateInstance();
private static final DateFormat DEFAULT_TIME_FORMAT = DateFormat.getTimeInstance();
- private static final DateFormat ISO_8601_FORMAT = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
- private static final DateFormat ISO_8601_FORMAT_NOZ = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
- private static DateFormat[] ALL_DATE_FORMATS = null;
- private static Calendar CALENDAR = null;
- private static final Pattern GENERAL_TIMESTAMP_PATTERN
- = Pattern.compile("(\\d{4})\\D(\\d{2})\\D(\\d{2})\\D(\\d{2})\\D(\\d{2})\\D(\\d{2})");
- private static Matcher GENERAL_TIMESTAMP_MATCHER = null;
- private static long SECS_SINCE_1970 = 0L;
- private static long SECS_SINCE_GARTRIP = 0L;
- private static long MSECS_SINCE_1970 = 0L;
- private static long MSECS_SINCE_1990 = 0L;
- private static long TWENTY_YEARS_IN_SECS = 0L;
- private static final long GARTRIP_OFFSET = 631065600L;
- /** Specifies original timestamp format */
- public static final int FORMAT_ORIGINAL = 0;
- /** Specifies locale-dependent timestamp format */
- public static final int FORMAT_LOCALE = 1;
- /** Specifies ISO 8601 timestamp format */
- public static final int FORMAT_ISO_8601 = 2;
+ protected static final DateFormat DEFAULT_DATETIME_FORMAT = DateFormat.getDateTimeInstance();
- // Static block to initialise offsets
- static
- {
- CALENDAR = Calendar.getInstance();
- MSECS_SINCE_1970 = CALENDAR.getTimeInMillis();
- SECS_SINCE_1970 = MSECS_SINCE_1970 / 1000L;
- SECS_SINCE_GARTRIP = SECS_SINCE_1970 - GARTRIP_OFFSET;
- CALENDAR.add(Calendar.YEAR, -20);
- MSECS_SINCE_1990 = CALENDAR.getTimeInMillis();
- TWENTY_YEARS_IN_SECS = (MSECS_SINCE_1970 - MSECS_SINCE_1990) / 1000L;
- // Date formats
- ALL_DATE_FORMATS = new DateFormat[] {
- DEFAULT_DATE_FORMAT,
- new SimpleDateFormat("EEE MMM dd HH:mm:ss yyyy"),
- new SimpleDateFormat("HH:mm:ss dd MMM yyyy"),
- new SimpleDateFormat("dd MMM yyyy HH:mm:ss"),
- new SimpleDateFormat("yyyy MMM dd HH:mm:ss"),
- ISO_8601_FORMAT, ISO_8601_FORMAT_NOZ
- };
- }
+ protected static final DateFormat ISO_8601_FORMAT
+ = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
+ protected static final DateFormat ISO_8601_FORMAT_WITH_MILLIS
+ = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
+ private static boolean MillisAddedToTimeFormat = false;
- /**
- * Constructor
- * @param inString String containing timestamp
- */
- public Timestamp(String inString)
+
+ /** Possible formats for parsing and displaying timestamps */
+ public enum Format
{
- // TODO: Does it really help to store timestamps in seconds rather than ms?
- if (inString != null && !inString.equals(""))
- {
- // Try to parse into a long
- try
- {
- long rawValue = Long.parseLong(inString.trim());
- _seconds = getSeconds(rawValue);
- _valid = true;
- }
- catch (NumberFormatException nfe)
- {
- // String is not a long, so try a date/time string instead
- // try each of the date formatters in turn
- Date date = null;
- for (int i=0; i<ALL_DATE_FORMATS.length && !_valid; i++)
- {
- try
- {
- date = ALL_DATE_FORMATS[i].parse(inString);
- CALENDAR.setTime(date);
- _seconds = CALENDAR.getTimeInMillis() / 1000L;
- _valid = true;
- }
- catch (ParseException e) {}
- }
- if (!_valid && inString.length() == 19) {
- GENERAL_TIMESTAMP_MATCHER = GENERAL_TIMESTAMP_PATTERN.matcher(inString);
- if (GENERAL_TIMESTAMP_MATCHER.matches()) {
- try {
- _seconds = getSeconds(Integer.parseInt(GENERAL_TIMESTAMP_MATCHER.group(1)),
- Integer.parseInt(GENERAL_TIMESTAMP_MATCHER.group(2)),
- Integer.parseInt(GENERAL_TIMESTAMP_MATCHER.group(3)),
- Integer.parseInt(GENERAL_TIMESTAMP_MATCHER.group(4)),
- Integer.parseInt(GENERAL_TIMESTAMP_MATCHER.group(5)),
- Integer.parseInt(GENERAL_TIMESTAMP_MATCHER.group(6)));
- _valid = true;
- }
- catch (NumberFormatException nfe2) {} // parse shouldn't fail if matcher matched
- }
- }
- }
- }
+ ORIGINAL,
+ LOCALE,
+ ISO8601
}
- /**
- * Constructor giving each field value individually
- * @param inYear year
- * @param inMonth month, beginning with 1
- * @param inDay day of month, beginning with 1
- * @param inHour hour of day, 0-24
- * @param inMinute minute
- * @param inSecond seconds
- */
- public Timestamp(int inYear, int inMonth, int inDay, int inHour, int inMinute, int inSecond)
+ // Static block to initialise date formats
+ static
{
- _seconds = getSeconds(inYear, inMonth, inDay, inHour, inMinute, inSecond);
- _valid = true;
+ // Set timezone for output
+ TimeZone gmtZone = TimeZone.getTimeZone("GMT");
+ ISO_8601_FORMAT.setTimeZone(gmtZone);
+ ISO_8601_FORMAT_WITH_MILLIS.setTimeZone(gmtZone);
+ DEFAULT_DATETIME_FORMAT.setTimeZone(gmtZone);
}
/**
- * Constructor giving millis
- * @param inMillis milliseconds since 1970
+ * @return true if valid
*/
- public Timestamp(long inMillis)
- {
- _seconds = inMillis / 1000;
- _valid = true;
- }
+ public abstract boolean isValid();
+ /**
+ * Get a calendar representing this timestamp
+ */
+ public abstract Calendar getCalendar(TimeZone inZone);
/**
- * Convert the given timestamp parameters into a number of seconds
- * @param inYear year
- * @param inMonth month, beginning with 1
- * @param inDay day of month, beginning with 1
- * @param inHour hour of day, 0-24
- * @param inMinute minute
- * @param inSecond seconds
- * @return number of seconds
+ * @return the milliseconds according to the given timezone
*/
- private static long getSeconds(int inYear, int inMonth, int inDay, int inHour, int inMinute, int inSecond)
- {
- Calendar cal = Calendar.getInstance();
- cal.set(Calendar.YEAR, inYear);
- cal.set(Calendar.MONTH, inMonth - 1);
- cal.set(Calendar.DAY_OF_MONTH, inDay);
- cal.set(Calendar.HOUR_OF_DAY, inHour);
- cal.set(Calendar.MINUTE, inMinute);
- cal.set(Calendar.SECOND, inSecond);
- cal.set(Calendar.MILLISECOND, 0);
- return cal.getTimeInMillis() / 1000;
- }
+ public abstract long getMilliseconds(TimeZone inZone);
/**
- * Convert the given long parameters into a number of seconds
- * @param inRawValue long value representing seconds / milliseconds
- * @return number of seconds
+ * @return true if this timestamp is after the other one
*/
- private static long getSeconds(long inRawValue)
+ public boolean isAfter(Timestamp inOther)
{
- // check for each format possibility and pick nearest
- long diff1 = Math.abs(SECS_SINCE_1970 - inRawValue);
- long diff2 = Math.abs(MSECS_SINCE_1970 - inRawValue);
- long diff3 = Math.abs(MSECS_SINCE_1990 - inRawValue);
- long diff4 = Math.abs(SECS_SINCE_GARTRIP - inRawValue);
-
- // Start off with "seconds since 1970" format
- long smallestDiff = diff1;
- long seconds = inRawValue;
- // Now check millis since 1970
- if (diff2 < smallestDiff)
- {
- // milliseconds since 1970
- seconds = inRawValue / 1000L;
- smallestDiff = diff2;
- }
- // Now millis since 1990
- if (diff3 < smallestDiff)
- {
- // milliseconds since 1990
- seconds = inRawValue / 1000L + TWENTY_YEARS_IN_SECS;
- smallestDiff = diff3;
- }
- // Lastly, check gartrip offset
- if (diff4 < smallestDiff)
- {
- // seconds since gartrip offset
- seconds = inRawValue + GARTRIP_OFFSET;
- }
- return seconds;
+ return getMillisecondsSince(inOther) > 0;
}
/**
- * @return true if timestamp is valid
+ * @return true if this timestamp is before the other one
*/
- public boolean isValid()
+ public boolean isBefore(Timestamp inOther)
{
- return _valid;
+ return getMillisecondsSince(inOther) < 0;
}
/**
- * @param inOther other Timestamp
- * @return true if this one is after the other
+ * @return true if this timestamp is equal to the other one
*/
- public boolean isAfter(Timestamp inOther)
+ public boolean isEqual(Timestamp inOther)
{
- return _seconds > inOther._seconds;
+ return getMillisecondsSince(inOther) == 0;
}
/**
- * Calculate the difference between two Timestamps in seconds
- * @param inOther other, earlier Timestamp
- * @return number of seconds since other timestamp
+ * @return the number of seconds since the other timestamp
*/
public long getSecondsSince(Timestamp inOther)
{
- return _seconds - inOther._seconds;
+ return getMillisecondsSince(inOther) / 1000L;
}
/**
- * Add the given number of seconds offset
- * @param inOffset number of seconds to add/subtract
+ * Calculate the difference between two Timestamps in milliseconds
+ * @param inOther other, earlier Timestamp
+ * @return number of milliseconds since other timestamp
*/
- public void addOffset(long inOffset)
+ public long getMillisecondsSince(Timestamp inOther)
{
- _seconds += inOffset;
- _text = null;
+ return getMilliseconds(null) - inOther.getMilliseconds(null);
}
/**
- * Add the given TimeDifference to this Timestamp
- * @param inOffset TimeDifference to add
- * @return new Timestamp object
+ * @return the number of seconds since the other timestamp using the given timezone
*/
- public Timestamp createPlusOffset(TimeDifference inOffset)
+ public long getSecondsSince(Timestamp inOther, TimeZone inTimezone)
{
- return new Timestamp((_seconds + inOffset.getTotalSeconds()) * 1000L);
+ return (getMilliseconds(inTimezone) - inOther.getMilliseconds(inTimezone)) / 1000L;
}
-
/**
- * Subtract the given TimeDifference from this Timestamp
- * @param inOffset TimeDifference to subtract
- * @return new Timestamp object
+ * Add the given number of seconds offset
+ * @param inOffset number of seconds to add/subtract
*/
- public Timestamp createMinusOffset(TimeDifference inOffset)
- {
- return new Timestamp((_seconds - inOffset.getTotalSeconds()) * 1000L);
- }
-
+ public abstract void addOffsetSeconds(long inOffset);
/**
- * @return Description of timestamp in locale-specific format
+ * @return true if the timestamp has non-zero milliseconds
*/
- public String getText()
- {
- return getText(FORMAT_LOCALE);
- }
+ protected abstract boolean hasMilliseconds();
+
/**
- * @param inFormat format of timestamp
- * @return Description of timestamp in required format
+ * @return date part of timestamp in locale-specific format
*/
- public String getText(int inFormat)
+ public String getDateText(TimeZone inTimezone)
{
- if (!_valid) {return "";}
- if (inFormat == FORMAT_ISO_8601) {
- return format(ISO_8601_FORMAT);
- }
- if (_text == null) {
- _text = (_valid?format(DEFAULT_DATE_FORMAT):"");
- }
- return _text;
+ if (!isValid()) return "";
+ return format(DEFAULT_DATE_FORMAT, inTimezone);
}
/**
* @return Description of time part of timestamp in locale-specific format
*/
- public String getTimeText()
+ public String getTimeText(TimeZone inTimezone)
{
- if (_timeText == null)
+ if (!isValid()) return "";
+ // Maybe we should add milliseconds to this format?
+ if (hasMilliseconds() && !MillisAddedToTimeFormat)
{
- if (_valid) {
- _timeText = format(DEFAULT_TIME_FORMAT);
+ try
+ {
+ SimpleDateFormat sdf = (SimpleDateFormat) DEFAULT_TIME_FORMAT;
+ String pattern = sdf.toPattern();
+ if (pattern.indexOf("ss") > 0 && pattern.indexOf("SS") < 0)
+ {
+ sdf.applyPattern(pattern.replaceFirst("s+", "$0.SSS"));
+ MillisAddedToTimeFormat = true;
+ }
}
- else _timeText = "";
+ catch (ClassCastException cce) {}
}
- return _timeText;
+ return format(DEFAULT_TIME_FORMAT, inTimezone);
}
/**
* Utility method for formatting dates / times
- * @param inFormat formatter object
- * @return formatted String
*/
- private String format(DateFormat inFormat)
+ protected abstract String format(DateFormat inFormat, TimeZone inTimezone);
+
+
+ /**
+ * @return Description of timestamp in locale-specific format
+ */
+ public String getText(TimeZone inTimezone)
{
- CALENDAR.setTimeInMillis(_seconds * 1000L);
- return inFormat.format(CALENDAR.getTime());
+ return getText(Format.LOCALE, inTimezone);
}
/**
- * @return a Calendar object representing this timestamp
+ * @param inFormat format of timestamp
+ * @return Description of timestamp in required format
*/
- public Calendar getCalendar()
+ public String getText(Format inFormat, TimeZone inTimezone)
{
- Calendar cal = Calendar.getInstance();
- cal.setTimeInMillis(_seconds * 1000L);
- return cal;
+ if (!isValid()) {
+ return "";
+ }
+ switch (inFormat)
+ {
+ case ORIGINAL:
+ case LOCALE:
+ default:
+ return format(DEFAULT_DATETIME_FORMAT, inTimezone);
+ case ISO8601:
+ return format(hasMilliseconds() ? ISO_8601_FORMAT_WITH_MILLIS : ISO_8601_FORMAT,
+ inTimezone);
+ }
}
+
}
projects / GpsPrune.git / blobdiff