X-Git-Url: https://gitweb.fperrin.net/?a=blobdiff_plain;f=tim%2Fprune%2Fdata%2FTimestamp.java;h=ac144bb8c59e8247deb67438a9f5c8504c258ca9;hb=92dad5df664287acb51728e9ea599f150765d34a;hp=6b7f77b55d361d12de91897f8ee34983d305e9de;hpb=52bf9e8686c916be37a26a0b75340393d4478b05;p=GpsPrune.git

diff --git a/tim/prune/data/Timestamp.java b/tim/prune/data/Timestamp.java
index 6b7f77b..ac144bb 100644
--- a/tim/prune/data/Timestamp.java
+++ b/tim/prune/data/Timestamp.java
@@ -1,282 +1,193 @@
 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.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.getDateInstance();
+	private static final DateFormat DEFAULT_TIME_FORMAT = DateFormat.getTimeInstance();
 
-	private static DateFormat DEFAULT_DATE_FORMAT = DateFormat.getDateTimeInstance();
-	private static DateFormat DEFAULT_TIME_FORMAT = DateFormat.getTimeInstance();
-	private static DateFormat ISO_8601_FORMAT = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
-	private static DateFormat[] ALL_DATE_FORMATS = null;
-	private static Calendar CALENDAR = 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;
+	protected static final DateFormat DEFAULT_DATETIME_FORMAT = DateFormat.getDateTimeInstance();
 
-	/** 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 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'");
 
-	// Static block to initialise offsets
-	static
+	private static boolean MillisAddedToTimeFormat = false;
+
+
+	/** Possible formats for parsing and displaying timestamps */
+	public enum Format
 	{
-		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
-		};
+		ORIGINAL,
+		LOCALE,
+		ISO8601
 	}
 
 
-	/**
-	 * Constructor
-	 * @param inString String containing timestamp
-	 */
-	public Timestamp(String inString)
+	// Static block to initialise date formats
+	static
 	{
-		// 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());
-				// check for each format possibility and pick nearest
-				long diff1 = Math.abs(SECS_SINCE_1970 - rawValue);
-				long diff2 = Math.abs(MSECS_SINCE_1970 - rawValue);
-				long diff3 = Math.abs(MSECS_SINCE_1990 - rawValue);
-				long diff4 = Math.abs(SECS_SINCE_GARTRIP - rawValue);
-
-				// Start off with "seconds since 1970" format
-				long smallestDiff = diff1;
-				_seconds = rawValue;
-				// Now check millis since 1970
-				if (diff2 < smallestDiff)
-				{
-					// milliseconds since 1970
-					_seconds = rawValue / 1000L;
-					smallestDiff = diff2;
-				}
-				// Now millis since 1990
-				if (diff3 < smallestDiff)
-				{
-					// milliseconds since 1990
-					_seconds = rawValue / 1000L + TWENTY_YEARS_IN_SECS;
-					smallestDiff = diff3;
-				}
-				// Lastly, check gartrip offset
-				if (diff4 < smallestDiff)
-				{
-					// seconds since gartrip offset
-					_seconds = rawValue + GARTRIP_OFFSET;
-				}
-				_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) {}
-				}
-			}
-		}
+		// 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 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
+	 * @return true if valid
 	 */
-	public Timestamp(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);
-		_seconds = cal.getTimeInMillis() / 1000;
-		_valid = true;
-	}
-
+	public abstract boolean isValid();
 
 	/**
-	 * Constructor giving millis
-	 * @param inMillis milliseconds since 1970
+	 * Get a calendar representing this timestamp
 	 */
-	public Timestamp(long inMillis)
-	{
-		_seconds = inMillis / 1000;
-		_valid = true;
-	}
+	public abstract Calendar getCalendar(TimeZone inZone);
 
+	/**
+	 * @return the milliseconds according to the given timezone
+	 */
+	public abstract long getMilliseconds(TimeZone inZone);
 
 	/**
-	 * @return true if timestamp is valid
+	 * @return true if this timestamp is after the other one
 	 */
-	public boolean isValid()
+	public boolean isAfter(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 before the other one
 	 */
-	public boolean isAfter(Timestamp inOther)
+	public boolean isBefore(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 true if this timestamp is equal to the other one
 	 */
-	public long getSecondsSince(Timestamp inOther)
+	public boolean isEqual(Timestamp inOther)
 	{
-		return _seconds - inOther._seconds;
+		return getMillisecondsSince(inOther) == 0;
 	}
 
 	/**
-	 * Add the given number of seconds offset
-	 * @param inOffset number of seconds to add/subtract
+	 * @return the number of seconds since the other timestamp
 	 */
-	public void addOffset(long inOffset)
+	public long getSecondsSince(Timestamp inOther)
 	{
-		_seconds += inOffset;
-		_text = null;
+		return getMillisecondsSince(inOther) / 1000L;
 	}
 
 	/**
-	 * Add the given TimeDifference to this Timestamp
-	 * @param inOffset TimeDifference to add
-	 * @return new Timestamp object
+	 * Calculate the difference between two Timestamps in milliseconds
+	 * @param inOther other, earlier Timestamp
+	 * @return number of milliseconds since other timestamp
 	 */
-	public Timestamp createPlusOffset(TimeDifference inOffset)
+	public long getMillisecondsSince(Timestamp inOther)
 	{
-		return new Timestamp((_seconds + inOffset.getTotalSeconds()) * 1000L);
+		return getMilliseconds(null) - inOther.getMilliseconds(null);
 	}
 
-
 	/**
-	 * Subtract the given TimeDifference from this Timestamp
-	 * @param inOffset TimeDifference to subtract
-	 * @return new Timestamp object
+	 * @return the number of seconds since the other timestamp using the given timezone
 	 */
-	public Timestamp createMinusOffset(TimeDifference inOffset)
+	public long getSecondsSince(Timestamp inOther, TimeZone inTimezone)
 	{
-		return new Timestamp((_seconds - inOffset.getTotalSeconds()) * 1000L);
+		return (getMilliseconds(inTimezone) - inOther.getMilliseconds(inTimezone)) / 1000L;
 	}
 
+	/**
+	 * Add the given number of seconds offset
+	 * @param inOffset number of seconds to add/subtract
+	 */
+	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 (inFormat == FORMAT_ISO_8601) {
-			return format(ISO_8601_FORMAT);
-		}
-		if (_text == null)
-		{
-			if (_valid) {
-				_text = format(DEFAULT_DATE_FORMAT);
-			}
-			else _text = "";
-		}
-		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);
+		}
 	}
+
 }