Changeset 5501 in josm for trunk/src/org

Timestamp:

2012-09-05T22:15:03+02:00 (12 years ago)

Author:

bastiK

Message:

add session support for gpx layers (see #4029)

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/SessionSaveAsAction.java (modified) (2 diffs)
• actions/downloadtasks/DownloadGpsTask.java (modified) (1 diff)
• gui/layer/markerlayer/Marker.java (modified) (2 diffs)
• gui/layer/markerlayer/MarkerLayer.java (modified) (2 diffs)
• io/GpxImporter.java (modified) (3 diffs)
• io/session/GpxTracksSessionExporter.java (added)
• io/session/GpxTracksSessionImporter.java (added)
• io/session/OsmDataSessionExporter.java (modified) (4 diffs)
• io/session/SessionReader.java (modified) (1 diff)
• io/session/SessionWriter.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/actions/SessionSaveAsAction.java

@@ -51 +51 @@
     private boolean zipRequired;
 
-    /**
-     * Construct the action with "Save" as label.
-     */
     public SessionSaveAsAction() {
         super(tr("Save Session As..."), "save_as", tr("Save the current session to a new file."), null, true, "save_as-session", true);
@@ -72 +69 @@
         for (Layer l : layers) {
             SessionLayerExporter ex = exporters.get(l);
-            if (ex.requiresZip()) {
+            if (ex != null && ex.requiresZip()) {
                 zipRequired = true;
                 break;

trunk/src/org/openstreetmap/josm/actions/downloadtasks/DownloadGpsTask.java

@@ -124 +124 @@
             GpxImporterData layers = GpxImporter.loadLayers(rawData, reader.isGpxParsedProperly(), name, tr("Markers from {0}", name));
             
-            GpxLayer gpxLayer = addOrMergeLayer(layers.gpxLayer, findGpxMergeLayer());
-            addOrMergeLayer(layers.markerLayer, findMarkerMergeLayer(gpxLayer));
+            GpxLayer gpxLayer = addOrMergeLayer(layers.getGpxLayer(), findGpxMergeLayer());
+            addOrMergeLayer(layers.getMarkerLayer(), findMarkerMergeLayer(gpxLayer));
             
-            layers.postLayerTask.run();
+            layers.getPostLayerTask().run();
         }
         

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

@@ -170 +170 @@
     }
 
-
     /**
      * Plugins can add their Marker creation stuff at the bottom or top of this list
@@ -210 +209 @@
                 }
 
-
                 if (url == null) {
                     String symbolName = wpt.getString("symbol");

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

@@ -68 +68 @@
     private Marker currentMarker;
 
+    @Deprecated
+    public MarkerLayer(GpxData indata, String name, File associatedFile, GpxLayer fromLayer, boolean addMouseHandlerInConstructor) {
+        this(indata, name, associatedFile, fromLayer);
+    }
+
     public MarkerLayer(GpxData indata, String name, File associatedFile, GpxLayer fromLayer) {
-        this(indata, name, associatedFile, fromLayer, true);
-    }
-
-    public MarkerLayer(GpxData indata, String name, File associatedFile, GpxLayer fromLayer, boolean addMouseHandlerInConstructor) {
         super(name);
         this.setAssociatedFile(associatedFile);
@@ -105 +106 @@
             }
         }
-
-        if (addMouseHandlerInConstructor) {
-            SwingUtilities.invokeLater(new Runnable(){
-                public void run() {
-                    addMouseHandler();
-                }
-            });
-        }
-    }
-
-    public void addMouseHandler() {
+    }
+
+    @Override
+    public void hookUpMapView() {
         Main.map.mapView.addMouseListener(new MouseAdapter() {
             @Override public void mousePressed(MouseEvent e) {

trunk/src/org/openstreetmap/josm/io/GpxImporter.java

@@ -40 +40 @@
          * The imported GPX layer. May be null if no GPX data.
          */
-        public GpxLayer gpxLayer;
+        private GpxLayer gpxLayer;
         /**
          * The imported marker layer. May be null if no marker.
          */
-        public MarkerLayer markerLayer;
+        private MarkerLayer markerLayer;
         /**
          * The task to run after GPX and/or marker layer has been added to MapView.
          */
-        public Runnable postLayerTask;
+        private Runnable postLayerTask;
+
+        public GpxImporterData(GpxLayer gpxLayer, MarkerLayer markerLayer, Runnable postLayerTask) {
+            this.gpxLayer = gpxLayer;
+            this.markerLayer = markerLayer;
+            this.postLayerTask = postLayerTask;
+        }
+
+        public GpxLayer getGpxLayer() {
+            return gpxLayer;
+        }
+
+        public MarkerLayer getMarkerLayer() {
+            return markerLayer;
+        }
+
+        public Runnable getPostLayerTask() {
+            return postLayerTask;
+        }
     }
 
@@ -108 +126 @@
      * @see #addLayers
      */
-    public static GpxImporterData loadLayers(final GpxData data, final boolean parsedProperly, final String gpxLayerName, String markerLayerName) {
-        final GpxImporterData result = new GpxImporterData();
+    public static GpxImporterData loadLayers(final GpxData data, final boolean parsedProperly, 
+            final String gpxLayerName, String markerLayerName) {
+        GpxLayer gpxLayer = null;
+        MarkerLayer markerLayer = null;
         if (data.hasRoutePoints() || data.hasTrackPoints()) {
-            result.gpxLayer = new GpxLayer(data, gpxLayerName, data.storageFile != null);
+            gpxLayer = new GpxLayer(data, gpxLayerName, data.storageFile != null);
         }
         if (Main.pref.getBoolean("marker.makeautomarkers", true) && !data.waypoints.isEmpty()) {
-            result.markerLayer = new MarkerLayer(data, markerLayerName, data.storageFile, result.gpxLayer, false);
-            if (result.markerLayer.data.size() == 0) {
-                result.markerLayer = null;
+            markerLayer = new MarkerLayer(data, markerLayerName, data.storageFile, gpxLayer);
+            if (markerLayer.data.isEmpty()) {
+                markerLayer = null;
             }
         }
-        result.postLayerTask = new Runnable() {
+        Runnable postLayerTask = new Runnable() {
             @Override
             public void run() {
-                if (result.markerLayer != null) {
-                    result.markerLayer.addMouseHandler();
-                }
                 if (!parsedProperly) {
                     String msg;
@@ -138 +155 @@
             }
         };
-        return result;
+        return new GpxImporterData(gpxLayer, markerLayer, postLayerTask);
+    }
+
+    public static GpxImporterData loadLayers(InputStream is, final File associatedFile,
+            final String gpxLayerName, String markerLayerName, ProgressMonitor progressMonitor) throws IOException {
+        try {
+            final GpxReader r = new GpxReader(is);
+            final boolean parsedProperly = r.parse(true);
+            r.data.storageFile = associatedFile;
+            return loadLayers(r.data, parsedProperly, gpxLayerName, markerLayerName);
+        } catch (SAXException e) {
+            e.printStackTrace();
+            throw new IOException(tr("Parsing data for layer ''{0}'' failed", gpxLayerName));
+        }
     }
 }

trunk/src/org/openstreetmap/josm/io/session/OsmDataSessionExporter.java

@@ -49 +49 @@
 
     private OsmDataLayer layer;
+    private JRadioButton link, include;
+    private JCheckBox export;
 
     public OsmDataSessionExporter(OsmDataLayer layer) {
@@ -55 +57 @@
 
     public OsmDataSessionExporter() {
-    }
-
-    public OsmDataSessionExporter newInstance(OsmDataLayer layer) {
-        return new OsmDataSessionExporter(layer);
     }
 
@@ -69 +67 @@
         public LayerSaveAction() {
             putValue(SMALL_ICON, new ImageProvider("save").setWidth(16).get());
-            putValue(SHORT_DESCRIPTION, tr("Layer contains unsaved data - save to file."));
+            putValue(SHORT_DESCRIPTION, layer.requiresSaveToFile() ? 
+                    tr("Layer contains unsaved data - save to file.") :
+                    tr("Layer does not contain unsaved data."));
             updateEnabledState();
         }
@@ -82 +82 @@
         }
     }
-
-    private JRadioButton link, include;
-    private JCheckBox export;
 
     @Override

trunk/src/org/openstreetmap/josm/io/session/SessionReader.java

@@ -57 +57 @@
         registerSessionLayerImporter("osm-data", OsmDataSessionImporter.class);
         registerSessionLayerImporter("imagery", ImagerySessionImporter.class);
+        registerSessionLayerImporter("tracks", GpxTracksSessionImporter.class);
     }
 

trunk/src/org/openstreetmap/josm/io/session/SessionWriter.java

@@ -28 +28 @@
 import javax.xml.transform.stream.StreamResult;
 
-import org.w3c.dom.Document;
-import org.w3c.dom.Element;
-import org.w3c.dom.Text;
-
+import org.openstreetmap.josm.gui.layer.GpxLayer;
 import org.openstreetmap.josm.gui.layer.Layer;
 import org.openstreetmap.josm.gui.layer.OsmDataLayer;
@@ -38 +35 @@
 import org.openstreetmap.josm.tools.MultiMap;
 import org.openstreetmap.josm.tools.Utils;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Text;
 
 public class SessionWriter {
@@ -47 +47 @@
         registerSessionLayerExporter(TMSLayer.class , ImagerySessionExporter.class);
         registerSessionLayerExporter(WMSLayer.class , ImagerySessionExporter.class);
+        registerSessionLayerExporter(GpxLayer.class , GpxTracksSessionExporter.class);
     }
 
@@ -86 +87 @@
     }
 
+    /**
+     * A class that provides some context for the individual {@link SessionLayerExporter}
+     * when doing the export.
+     */
     public class ExportSupport {
         private Document doc;
@@ -103 +108 @@
         }
 
+        /**
+         * Get the index of the layer that is currently exported.
+         * @return the index of the layer that is currently exported
+         */
         public int getLayerIndex() {
             return layerIndex;
@@ -108 +117 @@
 
         /**
-         * Create a file in the zip archive.
+         * Create a file inside the zip archive.
          *
-         * @return never close the output stream, but make sure to flush buffers
+         * @param zipPath the path inside the zip archive, e.g. "layers/03/data.xml"
+         * @return the OutputStream you can write to. Never close the returned
+         * output stream, but make sure to flush buffers.
          */
         public OutputStream getOutputStreamZip(String zipPath) throws IOException {
@@ -119 +130 @@
         }
 
+        /**
+         * Check, if the session is exported as a zip archive.
+         *
+         * @return true, if the session is exported as a zip archive (.joz file
+         * extension). It will always return true, if one of the
+         * {@link SessionLayerExporter} returns true for the
+         * {@link SessionLayerExporter#requiresZip()} method. Otherwise, the
+         * user can decide in the file chooser dialog.
+         */
         public boolean isZip() {
             return zip;