Changeset 5684 in josm for trunk/src/org/openstreetmap/josm/gui

Timestamp:

2013-01-28T14:06:52+01:00 (13 years ago)

Author:

bastiK

Message:

add session support for marker layers (see #4029)

The data is exported to a separate GPX file that contains one waypoint for each marker.
This is not very elegant, because most of the time, all the info is already contained in the original GPX File.
However, when dealing with audio markers, they can be synchronized, or additional markers are added
at certain playback positions. This info must be retained.
Another complication is, that two or more MarkerLayers can be merged to one.

All these problems are avoided by explicitly exporting the markers to a separate file (as done in this commit).

Location:

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer

Files:

• AudioMarker.java (modified) (2 diffs)
• ImageMarker.java (modified) (3 diffs)
• Marker.java (modified) (11 diffs)
• MarkerLayer.java (modified) (2 diffs)
• MarkerProducers.java (modified) (1 diff)
• WebMarker.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/AudioMarker.java

@@ -4 +4 @@
 import java.awt.event.ActionEvent;
 import java.net.URL;
+import java.util.Collections;
 
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.coor.LatLon;
+import org.openstreetmap.josm.data.gpx.GpxConstants;
+import org.openstreetmap.josm.data.gpx.GpxLink;
+import org.openstreetmap.josm.data.gpx.WayPoint;
 import org.openstreetmap.josm.tools.AudioPlayer;
 import org.openstreetmap.josm.tools.template_engine.TemplateEngineDataProvider;
@@ -77 +81 @@
         return TemplateEntryProperty.forAudioMarker(parentLayer.getName());
     }
+
+    @Override
+    public WayPoint convertToWayPoint() {
+        WayPoint wpt = super.convertToWayPoint();
+        GpxLink link = new GpxLink(audioUrl.toString());
+        link.type = "audio";
+        wpt.attr.put(GpxConstants.META_LINKS, Collections.singleton(link));
+        wpt.addExtension("offset", Double.toString(offset));
+        wpt.addExtension("sync-offset", Double.toString(syncOffset));
+        return wpt;
+    }
 }

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/ImageMarker.java

@@ -8 +8 @@
 import java.awt.event.ActionListener;
 import java.net.URL;
+import java.util.Collections;
 
 import javax.swing.Icon;
@@ -21 +22 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.coor.LatLon;
+import org.openstreetmap.josm.data.gpx.GpxConstants;
+import org.openstreetmap.josm.data.gpx.GpxLink;
+import org.openstreetmap.josm.data.gpx.WayPoint;
 import org.openstreetmap.josm.tools.ImageProvider;
 
@@ -83 +87 @@
     }
 
+    @Override
+    public WayPoint convertToWayPoint() {
+        WayPoint wpt = super.convertToWayPoint();
+        GpxLink link = new GpxLink(imageUrl.toString());
+        link.type = "image";
+        wpt.attr.put(GpxConstants.META_LINKS, Collections.singleton(link));
+        return wpt;
+    }
+
 }

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/Marker.java

@@ -8 +8 @@
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Date;
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
+import java.util.TimeZone;
 
 import javax.swing.Icon;
@@ -23 +27 @@
 import org.openstreetmap.josm.data.coor.EastNorth;
 import org.openstreetmap.josm.data.coor.LatLon;
+import org.openstreetmap.josm.data.gpx.Extensions;
 import org.openstreetmap.josm.data.gpx.GpxConstants;
 import org.openstreetmap.josm.data.gpx.GpxLink;
@@ -181 +186 @@
         Marker.markerProducers.add(new MarkerProducers() {
             @SuppressWarnings("unchecked")
+            @Override
             public Marker createMarker(WayPoint wpt, File relativePath, MarkerLayer parentLayer, double time, double offset) {
                 String uri = null;
@@ -217 +223 @@
                 }
                 else if (url.toString().endsWith(".wav")) {
-                    return new AudioMarker(wpt.getCoor(), wpt, url, parentLayer, time, offset);
+                    AudioMarker audioMarker = new AudioMarker(wpt.getCoor(), wpt, url, parentLayer, time, offset);
+                    Extensions exts = (Extensions) wpt.get(GpxConstants.META_EXTENSIONS);
+                    if (exts != null && exts.containsKey("offset")) {
+                        try {
+                            double syncOffset = Double.parseDouble(exts.get("sync-offset"));
+                            audioMarker.syncOffset = syncOffset;
+                        } catch (NumberFormatException nfe) {}
+                    }
+                    return audioMarker;
                 } else if (url.toString().endsWith(".png") || url.toString().endsWith(".jpg") || url.toString().endsWith(".jpeg") || url.toString().endsWith(".gif")) {
                     return new ImageMarker(wpt.getCoor(), url, parentLayer, time, offset);
@@ -234 +248 @@
      * @param relativePath An path to use for constructing relative URLs or
      *        <code>null</code> for no relative URLs
+     * @param parentLayer the <code>MarkerLayer</code> that will contain the created <code>Marker</code>
+     * @param time time of the marker in seconds since epoch
      * @param offset double in seconds as the time offset of this marker from
      *        the GPX file from which it was derived (if any).
@@ -247 +263 @@
     }
 
+    private static final DateFormat timeFormatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
+    static {
+         TimeZone tz = TimeZone.getTimeZone("UTC");
+         timeFormatter.setTimeZone(tz);
+    }
+
     public static final String MARKER_OFFSET = "waypointOffset";
     public static final String MARKER_FORMATTED_OFFSET = "formattedWaypointOffset";
@@ -254 +276 @@
     public static final String LABEL_PATTERN_DESC = "{desc}";
 
-
     private final TemplateEngineDataProvider dataProvider;
     private final String text;
@@ -260 +281 @@
     public final Icon symbol;
     public final MarkerLayer parentLayer;
-    public double time; /* absolute time of marker since epoch */
+    public double time; /* absolute time of marker in seconds since epoch */
     public double offset; /* time offset in seconds from the gpx point from which it was derived,
                              may be adjusted later to sync with other data, so not final */
@@ -296 +317 @@
     }
 
+    /**
+     * Convert Marker to WayPoint so it can be exported to a GPX file.
+     *
+     * Override in subclasses to add all necessary attributes.
+     * 
+     * @return the corresponding WayPoint with all relevant attributes
+     */
+    public WayPoint convertToWayPoint() {
+        WayPoint wpt = new WayPoint(getCoor());
+        wpt.put("time", timeFormatter.format(new Date(Math.round(time * 1000))));
+        if (text != null) {
+            wpt.addExtension("text", text);
+        } else if (dataProvider != null) {
+            for (String key : dataProvider.getTemplateKeys()) {
+                Object value = dataProvider.getTemplateValue(key, false);
+                if (value != null && GpxConstants.WPT_KEYS.contains(key)) {
+                    wpt.put(key, value);
+                }
+            }
+        }
+        return wpt;
+    }
+
     public final void setCoor(LatLon coor) {
         if(this.coor == null) {
@@ -343 +387 @@
      * @param mv map view
      * @param mousePressed true if the left mouse button is pressed
+     * @param showTextOrIcon true if text and icon shall be drawn
      */
     public void paint(Graphics g, MapView mv, boolean mousePressed, boolean showTextOrIcon) {
@@ -398 +443 @@
     }
 
-    private String formatOffset () {
+    private String formatOffset() {
         int wholeSeconds = (int)(offset + 0.5);
         if (wholeSeconds < 60)

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/MarkerLayer.java

@@ -32 +32 @@
 import org.openstreetmap.josm.data.Bounds;
 import org.openstreetmap.josm.data.coor.LatLon;
+import org.openstreetmap.josm.data.gpx.Extensions;
 import org.openstreetmap.josm.data.gpx.GpxConstants;
 import org.openstreetmap.josm.data.gpx.GpxData;
@@ -108 +109 @@
                 }
             }
-            Marker m = Marker.createMarker(wpt, indata.storageFile, this, time, time - firstTime);
+            Double offset = null;
+            // If we have an explicit offset, take it.
+            // Otherwise, for a group of markers with the same Link-URI (e.g. an
+            // audio file) calculate the offset relative to the first marker of
+            // that group. This way the user can jump to the corresponding
+            // playback positions in a long audio track.
+            Extensions exts = (Extensions) wpt.get(GpxConstants.META_EXTENSIONS);
+            if (exts != null && exts.containsKey("offset")) {
+                try {
+                    offset = Double.parseDouble(exts.get("offset"));
+                } catch (NumberFormatException nfe) {}
+            }
+            if (offset == null) {
+                offset = time - firstTime;
+            }
+            Marker m = Marker.createMarker(wpt, indata.storageFile, this, time, offset);
             if (m != null) {
                 data.add(m);

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/MarkerProducers.java

@@ -24 +24 @@
      * @return A Marker object, or <code>null</code>.
      */
-    public Marker createMarker(WayPoint wp, File relativePath, MarkerLayer parentLayer, double time, double offset);
+    Marker createMarker(WayPoint wp, File relativePath, MarkerLayer parentLayer, double time, double offset);
 }

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/WebMarker.java

@@ -6 +6 @@
 import java.awt.event.ActionEvent;
 import java.net.URL;
+import java.util.Collections;
 
 import javax.swing.JOptionPane;
@@ -11 +12 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.coor.LatLon;
+import org.openstreetmap.josm.data.gpx.GpxConstants;
+import org.openstreetmap.josm.data.gpx.GpxLink;
+import org.openstreetmap.josm.data.gpx.WayPoint;
 import org.openstreetmap.josm.tools.OpenBrowser;
 
@@ -38 +42 @@
         }
     }
+
+    @Override
+    public WayPoint convertToWayPoint() {
+        WayPoint wpt = super.convertToWayPoint();
+        GpxLink link = new GpxLink(webUrl.toString());
+        link.type = "web";
+        wpt.attr.put(GpxConstants.META_LINKS, Collections.singleton(link));
+        return wpt;
+    }
 }