Changeset 17845 in josm

Timestamp:

2021-05-01T14:00:25+02:00 (3 years ago)

Author:

simon04

Message:

see #14176 - Introduce class Interval

Location:

trunk

Files:

• src/org/openstreetmap/josm/data/gpx/GpxData.java (modified) (5 diffs)
• src/org/openstreetmap/josm/gui/layer/GpxLayer.java (modified) (4 diffs)
• src/org/openstreetmap/josm/gui/layer/gpx/ChooseTrackVisibilityAction.java (modified) (5 diffs)
• src/org/openstreetmap/josm/gui/layer/gpx/DateFilterPanel.java (modified) (2 diffs)
• src/org/openstreetmap/josm/gui/layer/gpx/GpxDrawHelper.java (modified) (2 diffs)
• src/org/openstreetmap/josm/tools/date/Interval.java (added)
• test/unit/org/openstreetmap/josm/data/gpx/GpxDataTest.java (modified) (3 diffs)
• test/unit/org/openstreetmap/josm/gui/layer/GpxLayerTest.java (modified) (2 diffs)
• test/unit/org/openstreetmap/josm/tools/date/IntervalTest.java (added)

trunk/src/org/openstreetmap/josm/data/gpx/GpxData.java

@@ -33 +33 @@
 import org.openstreetmap.josm.tools.ListenerList;
 import org.openstreetmap.josm.tools.ListeningCollection;
+import org.openstreetmap.josm.tools.date.Interval;
 
 /**
@@ -718 +719 @@
      * returns minimum and maximum timestamps in the track
      * @param trk track to analyze
-     * @return  minimum and maximum dates in array of 2 elements
-     */
-    public static Instant[] getMinMaxTimeForTrack(IGpxTrack trk) {
+     * @return minimum and maximum as interval
+     */
+    public static Optional<Interval> getMinMaxTimeForTrack(IGpxTrack trk) {
         final LongSummaryStatistics statistics = trk.getSegments().stream()
                 .flatMap(seg -> seg.getWayPoints().stream())
@@ -726 +727 @@
                 .summaryStatistics();
         return statistics.getCount() == 0 || (statistics.getMin() == 0 && statistics.getMax() == 0)
-                ? null
-                : new Instant[]{Instant.ofEpochMilli(statistics.getMin()), Instant.ofEpochMilli(statistics.getMax())};
+                ? Optional.empty()
+                : Optional.of(new Interval(Instant.ofEpochMilli(statistics.getMin()), Instant.ofEpochMilli(statistics.getMax())));
     }
 
@@ -734 +735 @@
     * Warning: there are lot of track with broken timestamps,
     * so we just ignore points from future and from year before 1970 in this method
-    * @return minimum and maximum dates in array of 2 elements
+    * @return minimum and maximum as interval
     * @since 7319
     */
-    public synchronized Instant[] getMinMaxTimeForAllTracks() {
+    public synchronized Optional<Interval> getMinMaxTimeForAllTracks() {
         long now = System.currentTimeMillis();
         final LongSummaryStatistics statistics = tracks.stream()
@@ -746 +747 @@
                 .summaryStatistics();
         return statistics.getCount() == 0
-                ? new Instant[0]
-                : new Instant[]{Instant.ofEpochMilli(statistics.getMin()), Instant.ofEpochMilli(statistics.getMax())};
+                ? Optional.empty()
+                : Optional.of(new Interval(Instant.ofEpochMilli(statistics.getMin()), Instant.ofEpochMilli(statistics.getMax())));
     }
 

trunk/src/org/openstreetmap/josm/gui/layer/GpxLayer.java

@@ -40 +40 @@
 import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.Utils;
-import org.openstreetmap.josm.tools.date.DateUtils;
+import org.openstreetmap.josm.tools.date.Interval;
 
 import javax.swing.AbstractAction;
@@ -53 +53 @@
 import java.io.File;
 import java.time.Instant;
-import java.time.format.DateTimeFormatter;
-import java.time.format.FormatStyle;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -157 +155 @@
      */
     public static String getTimespanForTrack(IGpxTrack trk) {
-        Instant[] bounds = GpxData.getMinMaxTimeForTrack(trk);
-        return bounds != null ? formatTimespan(bounds) : "";
-    }
-
-    /**
-     * Formats the timespan of the given track as a human readable string
-     * @param bounds The bounds to format, i.e., an array containing the min/max date
-     * @return The timespan as a string
-     */
-    public static String formatTimespan(Instant[] bounds) {
-        String ts = "";
-        DateTimeFormatter df = DateUtils.getDateFormatter(FormatStyle.SHORT);
-        String earliestDate = df.format(bounds[0]);
-        String latestDate = df.format(bounds[1]);
-
-        if (earliestDate.equals(latestDate)) {
-            DateTimeFormatter tf = DateUtils.getTimeFormatter(FormatStyle.SHORT);
-            ts += earliestDate + ' ';
-            ts += tf.format(bounds[0]) + " \u2013 " + tf.format(bounds[1]);
-        } else {
-            DateTimeFormatter dtf = DateUtils.getDateTimeFormatter(FormatStyle.SHORT, FormatStyle.MEDIUM);
-            ts += dtf.format(bounds[0]) + " \u2013 " + dtf.format(bounds[1]);
-        }
-
-        ts += String.format(" (%s)", Utils.getDurationString(bounds[1].toEpochMilli() - bounds[0].toEpochMilli()));
-        return ts;
+        return GpxData.getMinMaxTimeForTrack(trk).map(Interval::format).orElse("");
     }
 
@@ -354 +327 @@
         long to = toDate.toEpochMilli();
         for (IGpxTrack trk : data.getTracks()) {
-            Instant[] t = GpxData.getMinMaxTimeForTrack(trk);
+            Interval t = GpxData.getMinMaxTimeForTrack(trk).orElse(null);
 
             if (t == null) continue;
-            long tm = t[1].toEpochMilli();
+            long tm = t.getEnd().toEpochMilli();
             trackVisibility[i] = (tm == 0 && showWithoutDate) || (from <= tm && tm <= to);
             i++;

trunk/src/org/openstreetmap/josm/gui/layer/gpx/ChooseTrackVisibilityAction.java

@@ -54 +54 @@
 import org.openstreetmap.josm.tools.ImageProvider;
 import org.openstreetmap.josm.tools.OpenBrowser;
+import org.openstreetmap.josm.tools.date.Interval;
 
 /**
@@ -88 +89 @@
             String name = (String) Optional.ofNullable(attr.get(GpxConstants.GPX_NAME)).orElse("");
             String desc = (String) Optional.ofNullable(attr.get(GpxConstants.GPX_DESC)).orElse("");
-            Instant[] time = GpxData.getMinMaxTimeForTrack(trk);
+            Interval time = GpxData.getMinMaxTimeForTrack(trk).orElse(null);
             String url = (String) Optional.ofNullable(attr.get("url")).orElse("");
             tracks[i] = new Object[]{name, desc, time, trk.length(), url, trk};
@@ -140 +141 @@
         t.setRowSorter(rowSorter);
         rowSorter.setModel(model);
-        rowSorter.setComparator(2, Comparator.comparing((Instant[] d) -> d == null ? Instant.MIN : d[0]));
+        rowSorter.setComparator(2, Comparator.comparing((Interval d) -> d == null ? Instant.MIN : d.getStart()));
         rowSorter.setComparator(3, Comparator.comparingDouble(length -> (double) length));
         // default column widths
@@ -150 +151 @@
             public Component getTableCellRendererComponent(
                     JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
-                if (value instanceof Instant[]) {
-                    value = GpxLayer.formatTimespan(((Instant[]) value));
+                if (value instanceof Interval) {
+                    value = ((Interval) value).format();
                 }
                 return super.getTableCellRendererComponent(table, value, isSelected, hasFocus, row, column);
@@ -327 +328 @@
                 JComponent jc = (JComponent) c;
                 Object value = getValueAt(row, col);
-                jc.setToolTipText(col == 2 ? Arrays.toString((Instant[]) value) : String.valueOf(value));
+                jc.setToolTipText(String.valueOf(value));
                 if (content.length > row
                         && content[row].length > 5

trunk/src/org/openstreetmap/josm/gui/layer/gpx/DateFilterPanel.java

@@ -20 +20 @@
 import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.tools.GBC;
+import org.openstreetmap.josm.tools.date.Interval;
 
 /**
@@ -51 +52 @@
         this.layer = layer;
 
-        final Instant startTime, endTime;
-        Instant[] bounds = layer.data.getMinMaxTimeForAllTracks();
-        if (bounds.length == 0) {
-            startTime = ZonedDateTime.of(2000, 1, 1, 0, 0, 0, 0, ZoneId.systemDefault()).toInstant();
-            endTime = Instant.now();
-        } else {
-            startTime = bounds[0];
-            endTime = bounds[1];
-        }
-
-        dateFrom.setDate(startTime);
-        dateTo.setDate(endTime);
-        dateFrom.setRange(startTime, endTime);
-        dateTo.setRange(startTime, endTime);
+        Interval interval = layer.data.getMinMaxTimeForAllTracks()
+                .orElseGet(() -> new Interval(ZonedDateTime.of(2000, 1, 1, 0, 0, 0, 0, ZoneId.systemDefault()).toInstant(), Instant.now()));
+        dateFrom.setDate(interval.getStart());
+        dateTo.setDate(interval.getEnd());
+        dateFrom.setRange(interval.getStart(), interval.getEnd());
+        dateTo.setRange(interval.getStart(), interval.getEnd());
 
         add(noTimestampCb, GBC.std().grid(1, 1).insets(0, 0, 5, 0));

trunk/src/org/openstreetmap/josm/gui/layer/gpx/GpxDrawHelper.java

@@ -60 +60 @@
 import org.openstreetmap.josm.tools.Stopwatch;
 import org.openstreetmap.josm.tools.Utils;
+import org.openstreetmap.josm.tools.date.Interval;
 
 /**
@@ -565 +566 @@
         double now = System.currentTimeMillis()/1000.0;
         if (colored == ColorMode.TIME) {
-            Instant[] bounds = data.getMinMaxTimeForAllTracks();
-            if (bounds.length >= 2) {
-                minval = bounds[0].getEpochSecond();
-                maxval = bounds[1].getEpochSecond();
-            } else {
-                minval = 0;
-                maxval = now;
-            }
+            Interval interval = data.getMinMaxTimeForAllTracks().orElse(new Interval(Instant.EPOCH, Instant.now()));
+            minval = interval.getStart().getEpochSecond();
+            maxval = interval.getEnd().getEpochSecond();
             dateScale.setRange(minval, maxval);
         }

trunk/test/unit/org/openstreetmap/josm/data/gpx/GpxDataTest.java

@@ -33 +33 @@
 import org.openstreetmap.josm.testutils.JOSMTestRules;
 import org.openstreetmap.josm.tools.ListenerList;
+import org.openstreetmap.josm.tools.date.Interval;
 import org.xml.sax.SAXException;
 
@@ -330 +331 @@
     @Test
     void testGetMinMaxTimeForAllTracks() {
-        assertEquals(0, data.getMinMaxTimeForAllTracks().length);
+        assertFalse(data.getMinMaxTimeForAllTracks().isPresent());
 
         WayPoint p1 = new WayPoint(LatLon.NORTH_POLE);
@@ -343 +344 @@
         data.addTrack(new GpxTrack(Arrays.asList(Arrays.asList(p3, p4, p5)), Collections.emptyMap()));
 
-        Instant[] times = data.getMinMaxTimeForAllTracks();
-        assertEquals(times.length, 2);
-        assertEquals(Instant.ofEpochMilli(100020), times[0]);
-        assertEquals(Instant.ofEpochMilli(500020), times[1]);
+        Interval times = data.getMinMaxTimeForAllTracks().orElse(null);
+        assertEquals("1970-01-01T00:01:40.020Z/1970-01-01T00:08:20.020Z", times.toString());
+        assertEquals(Instant.ofEpochMilli(100020), times.getStart());
+        assertEquals(Instant.ofEpochMilli(500020), times.getEnd());
     }
 

trunk/test/unit/org/openstreetmap/josm/gui/layer/GpxLayerTest.java

@@ -10 +10 @@
 import java.awt.Color;
 import java.io.IOException;
-import java.time.Instant;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -217 +216 @@
 
     /**
-     * Unit test of {@link GpxLayer#formatTimespan}.
-     */
-    @Test
-    void testFormatTimespan() {
-        Instant[] timespan = {Instant.parse("2021-03-01T17:53:16Z"), Instant.parse("2021-04-03T08:19:19Z")};
-        assertEquals("2021-03-01 17:53:16 \u2013 2021-04-03 08:19:19 (32 days 14 h)", GpxLayer.formatTimespan(timespan));
-    }
-
-    /**
      * Unit test of {@link GpxLayer#mergeFrom}.
      * @throws Exception if any error occurs