Changeset 8927 in josm for trunk

Timestamp:

2015-10-22T14:01:47+02:00 (9 years ago)

Author:

Don-vip

Message:

fix #11998 - add two new protected boolean members to simplify customization of OSM download task for plugins + fix some javadoc/sonar issues

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/downloadtasks/DownloadOsmTask.java (modified) (10 diffs)
• data/ProjectionBounds.java (modified) (1 diff)
• data/osm/visitor/BoundingXYVisitor.java (modified) (7 diffs)
• io/remotecontrol/handler/LoadDataHandler.java (modified) (2 diffs)

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

@@ -47 +47 @@
 
     protected String newLayerName;
+
+    /** This allows subclasses to ignore this warning */
+    protected boolean warnAboutEmptyArea = true;
 
     @Override
@@ -123 +126 @@
     /**
      * This allows subclasses to perform operations on the URL before {@link #loadUrl} is performed.
+     * @param url the original URL
+     * @return the modified URL
      */
     protected String modifyUrlBeforeLoad(String url) {
@@ -130 +135 @@
     /**
      * Loads a given URL from the OSM Server
-     * @param new_layer True if the data should be saved to a new layer
+     * @param newLayer True if the data should be saved to a new layer
      * @param url The URL as String
      */
     @Override
-    public Future<?> loadUrl(boolean new_layer, String url, ProgressMonitor progressMonitor) {
-        url = modifyUrlBeforeLoad(url);
-        downloadTask = new DownloadTask(new_layer,
-                new OsmServerLocationReader(url),
+    public Future<?> loadUrl(boolean newLayer, String url, ProgressMonitor progressMonitor) {
+        String newUrl = modifyUrlBeforeLoad(url);
+        downloadTask = new DownloadTask(newLayer,
+                new OsmServerLocationReader(newUrl),
                 progressMonitor);
         currentBounds = null;
         // Extract .osm filename from URL to set the new layer name
-        extractOsmFilename("https?://.*/(.*\\.osm)", url);
+        extractOsmFilename("https?://.*/(.*\\.osm)", newUrl);
         return Main.worker.submit(downloadTask);
     }
@@ -169 +174 @@
 
         protected final boolean newLayer;
+        protected final boolean zoomAfterDownload;
         protected DataSet dataSet;
 
@@ -179 +185 @@
          * exception will be thrown directly in EDT. When this runnable is executed using executor framework
          * then use false unless you read result of task (because exception will get lost if you don't)
+         * @param zoomAfterDownload If true, the map view will zoom to download area after download
          */
-        public AbstractInternalTask(boolean newLayer, String title, boolean ignoreException) {
+        public AbstractInternalTask(boolean newLayer, String title, boolean ignoreException, boolean zoomAfterDownload) {
             super(title, ignoreException);
             this.newLayer = newLayer;
+            this.zoomAfterDownload = zoomAfterDownload;
         }
 
@@ -194 +202 @@
          * exception will be thrown directly in EDT. When this runnable is executed using executor framework
          * then use false unless you read result of task (because exception will get lost if you don't)
+         * @param zoomAfterDownload If true, the map view will zoom to download area after download
          */
-        public AbstractInternalTask(boolean newLayer, String title, ProgressMonitor progressMonitor, boolean ignoreException) {
+        public AbstractInternalTask(boolean newLayer, String title, ProgressMonitor progressMonitor, boolean ignoreException,
+                boolean zoomAfterDownload) {
             super(title, progressMonitor, ignoreException);
             this.newLayer = newLayer;
+            this.zoomAfterDownload = zoomAfterDownload;
         }
 
@@ -206 +217 @@
 
         protected int getNumDataLayers() {
+            if (!Main.isDisplayingMapView()) return 0;
             int count = 0;
-            if (!Main.isDisplayingMapView()) return 0;
             Collection<Layer> layers = Main.map.mapView.getAllLayers();
             for (Layer layer : layers) {
@@ -276 +287 @@
                 }
                 layer.mergeFrom(dataSet);
-                computeBboxAndCenterScale(bounds);
+                if (zoomAfterDownload) {
+                    computeBboxAndCenterScale(bounds);
+                }
                 layer.onPostDownloadFromServer();
             }
@@ -285 +298 @@
         protected final OsmServerReader reader;
 
+        /**
+         * Constructs a new {@code DownloadTask}.
+         * @param newLayer if {@code true}, force download to a new layer
+         * @param reader OSM data reader
+         * @param progressMonitor progress monitor
+         */
         public DownloadTask(boolean newLayer, OsmServerReader reader, ProgressMonitor progressMonitor) {
-            super(newLayer, tr("Downloading data"), progressMonitor, false);
+            super(newLayer, tr("Downloading data"), progressMonitor, false, true);
             this.reader = reader;
         }
@@ -324 +343 @@
                 return; // user canceled download or error occurred
             if (dataSet.allPrimitives().isEmpty()) {
-                rememberErrorMessage(tr("No data found in this area."));
+                if (warnAboutEmptyArea) {
+                    rememberErrorMessage(tr("No data found in this area."));
+                }
                 // need to synthesize a download bounds lest the visual indication of downloaded area doesn't work
                 dataSet.dataSources.add(new DataSource(currentBounds != null ? currentBounds :

trunk/src/org/openstreetmap/josm/data/ProjectionBounds.java

@@ -89 +89 @@
     }
 
+    /**
+     * Determines if the bounds area is not null
+     * @return {@code true} if the area is not null
+     */
     public boolean hasExtend() {
         return !Utils.equalsEpsilon(minEast, maxEast) || !Utils.equalsEpsilon(minNorth, maxNorth);

trunk/src/org/openstreetmap/josm/data/osm/visitor/BoundingXYVisitor.java

@@ -48 +48 @@
     }
 
+    /**
+     * Visiting call for bounds.
+     * @param b bounds
+     */
     public void visit(Bounds b) {
         if (b != null) {
@@ -55 +59 @@
     }
 
+    /**
+     * Visiting call for projection bounds.
+     * @param b projection bounds
+     */
     public void visit(ProjectionBounds b) {
         if (b != null) {
@@ -62 +70 @@
     }
 
+    /**
+     * Visiting call for lat/lon.
+     * @param latlon lat/lon
+     */
     public void visit(LatLon latlon) {
         if (latlon != null) {
@@ -72 +84 @@
     }
 
+    /**
+     * Visiting call for east/north.
+     * @param eastNorth east/north
+     */
     public void visit(EastNorth eastNorth) {
         if (eastNorth != null) {
@@ -82 +98 @@
     }
 
+    /**
+     * Determines if the visitor has a non null bounds area.
+     * @return {@code true} if the visitor has a non null bounds area
+     * @see ProjectionBounds#hasExtend
+     */
     public boolean hasExtend() {
         return bounds != null && bounds.hasExtend();
@@ -174 +195 @@
             return;
         // convert size from meters to east/north units
-        double en_size = size * Main.map.mapView.getScale() / Main.map.mapView.getDist100Pixel() * 100;
-        visit(bounds.getMin().add(-en_size/2, -en_size/2));
-        visit(bounds.getMax().add(+en_size/2, +en_size/2));
+        double enSize = size * Main.map.mapView.getScale() / Main.map.mapView.getDist100Pixel() * 100;
+        visit(bounds.getMin().add(-enSize/2, -enSize/2));
+        visit(bounds.getMax().add(+enSize/2, +enSize/2));
     }
 
@@ -184 +205 @@
     }
 
+    /**
+     * Compute the bounding box of a collection of primitives.
+     * @param primitives the collection of primitives
+     */
     public void computeBoundingBox(Collection<? extends OsmPrimitive> primitives) {
         if (primitives == null) return;

trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/LoadDataHandler.java

@@ -60 +60 @@
     @Override
     public String[] getUsageExamples() {
-        final String data = Utils.encodeUrl("<osm version='0.6'><node id='-1' lat='1' lon='2' /></osm>");
         return new String[]{
-                "/load_data?layer_name=extra_layer&new_layer=true&data=" + data};
+                "/load_data?layer_name=extra_layer&new_layer=true&data=" +
+                    Utils.encodeUrl("<osm version='0.6'><node id='-1' lat='1' lon='2' /></osm>")};
     }
 
@@ -101 +101 @@
         protected final String layerName;
 
+        /**
+         * Constructs a new {@code LoadDataTask}.
+         * @param newLayer if {@code true}, force download to a new layer
+         * @param dataSet data set
+         * @param layerName layer name
+         */
         public LoadDataTask(boolean newLayer, DataSet dataSet, String layerName) {
-            super(newLayer, tr("Loading data"), false);
+            super(newLayer, tr("Loading data"), false, true);
             this.dataSet = dataSet;
             this.layerName = layerName;