Changeset 32064 in osm

Timestamp:

2016-02-11T23:17:18+01:00 (9 years ago)

Author:

floscher

Message:

[mapillary] Add ValidationUtil for validating sequence-keys and image-keys

Also some public attributes are now private with getters/setters where necessary.

Location:

applications/editors/josm/plugins/mapillary

Files:

• src/org/openstreetmap/josm/plugins/mapillary/MapillaryAbstractImage.java (modified) (3 diffs)
• src/org/openstreetmap/josm/plugins/mapillary/MapillaryData.java (modified) (6 diffs)
• src/org/openstreetmap/josm/plugins/mapillary/MapillaryImage.java (modified) (3 diffs)
• src/org/openstreetmap/josm/plugins/mapillary/MapillaryLayer.java (modified) (3 diffs)
• src/org/openstreetmap/josm/plugins/mapillary/MapillarySequence.java (modified) (2 diffs)
• src/org/openstreetmap/josm/plugins/mapillary/gui/MapillaryFilterDialog.java (modified) (1 diff)
• src/org/openstreetmap/josm/plugins/mapillary/io/download/MapillaryDownloader.java (modified) (3 diffs)
• src/org/openstreetmap/josm/plugins/mapillary/io/download/MapillarySequenceDownloadThread.java (modified) (1 diff)
• src/org/openstreetmap/josm/plugins/mapillary/utils/MapillaryURL.java (modified) (2 diffs)
• src/org/openstreetmap/josm/plugins/mapillary/utils/ValidationUtil.java (added)
• test/unit/org/openstreetmap/josm/plugins/mapillary/io/download/MapillarySequenceDownloadThreadTest.java (modified) (1 diff)

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryAbstractImage.java

@@ -28 +28 @@
   private MapillarySequence sequence;
   /** Position of the picture. */
-  public final LatLon latLon;
+  protected LatLon latLon;
   /** Direction of the picture. */
-  public final double ca;
+  protected double ca;
   /** Temporal position of the picture until it is uploaded. */
   public LatLon tempLatLon;
@@ -218 +218 @@
   }
 
+  public void setCa(final double ca) {
+    this.ca = ca;
+  }
+
   /**
    * Sets the Epoch time when the picture was captured.
@@ -225 +229 @@
   public void setCapturedAt(final long capturedAt) {
     this.capturedAt = capturedAt;
+  }
+
+  public void setLatLon(final LatLon latLon) {
+    if (latLon != null) {
+      this.latLon = latLon;
+    }
   }
 

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryData.java

@@ -11 +11 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.Bounds;
+import org.openstreetmap.josm.data.coor.LatLon;
 import org.openstreetmap.josm.plugins.mapillary.cache.CacheUtils;
 import org.openstreetmap.josm.plugins.mapillary.gui.MapillaryMainDialog;
+import org.openstreetmap.josm.plugins.mapillary.utils.MapillaryUtils;
 
 /**
@@ -22 +24 @@
  */
 public class MapillaryData {
-
   private final Set<MapillaryAbstractImage> images;
   /**
@@ -39 +40 @@
    * Listeners of the class.
    */
-  private final CopyOnWriteArrayList<MapillaryDataListener> listeners = new CopyOnWriteArrayList<>();
+  private final List<MapillaryDataListener> listeners = new CopyOnWriteArrayList<>();
   /**
    * The bounds of the areas for which the pictures have been downloaded.
    */
-  public List<Bounds> bounds;
+  private final List<Bounds> bounds;
 
   /**
@@ -52 +53 @@
     this.multiSelectedImages = Collections.newSetFromMap(new ConcurrentHashMap<MapillaryAbstractImage, Boolean>());
     this.selectedImage = null;
+    this.bounds = new CopyOnWriteArrayList<>();
 
     // Adds the basic set of listeners.
@@ -82 +84 @@
       this.images.add(image);
     }
-    if (update)
+    if (update) {
       dataUpdated();
+    }
     fireImagesAdded();
   }
@@ -151 +154 @@
     }
     Main.map.mapView.repaint();
+  }
+
+  public List<Bounds> getBounds() {
+    return bounds;
   }
 

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryImage.java

@@ -6 +6 @@
 
 import org.openstreetmap.josm.data.coor.LatLon;
+import org.openstreetmap.josm.plugins.mapillary.utils.MapillaryUtils;
+import org.openstreetmap.josm.plugins.mapillary.utils.ValidationUtil;
 
 /**
@@ -33 +35 @@
   public MapillaryImage(final String key, final LatLon latLon, final double ca) {
     super(latLon, ca);
+    ValidationUtil.throwExceptionForInvalidImgKey(key, true);
     this.key = key;
   }
@@ -105 +108 @@
   @Override
   public String toString() {
-    return "Image[key=" + this.key + ";lat=" + this.latLon.lat() + ";lon="
-        + this.latLon.lon() + ";ca=" + this.ca + ']';
+    return String.format(
+      "Image[key=%s,lat=%f,lon=%f,ca=%f,location=%s,user=%s,capturedAt=%d]",
+      key, latLon.lat(), latLon.lon(), ca, location, user, capturedAt
+    );
   }
 

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillaryLayer.java

@@ -20 +20 @@
 import java.awt.image.AffineTransformOp;
 import java.awt.image.BufferedImage;
-import java.util.concurrent.CopyOnWriteArrayList;
 
 import javax.swing.AbstractAction;
@@ -101 +100 @@
     super(tr("Mapillary Images"));
     this.data = new MapillaryData();
-    this.data.bounds = new CopyOnWriteArrayList<>();
   }
 
@@ -291 +289 @@
       // paint remainder
       g.setPaint(this.hatched);
-      g.fill(MapViewGeometryUtil.getNonDownloadedArea(mv, this.data.bounds));
+      g.fill(MapViewGeometryUtil.getNonDownloadedArea(mv, this.data.getBounds()));
     }
 

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/MapillarySequence.java

@@ -2 +2 @@
 package org.openstreetmap.josm.plugins.mapillary;
 
-import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
+
+import org.openstreetmap.josm.plugins.mapillary.utils.ValidationUtil;
 
 /**
@@ -39 +40 @@
    * @param key       The unique identifier of the sequence.
    * @param createdAt The date the sequence was created.
+   * @throws IllegalArgumentException if the key is invalid
+   *           according to {@link ValidationUtil#validateSequenceKey(String)}
    */
   public MapillarySequence(String key, long createdAt) {
+    ValidationUtil.throwExceptionForInvalidSeqKey(key, true);
+
     this.images = new CopyOnWriteArrayList<>();
     this.key = key;

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/gui/MapillaryFilterDialog.java

@@ -4 +4 @@
 import static org.openstreetmap.josm.tools.I18n.tr;
 
-import java.awt.*;
+import java.awt.FlowLayout;
+import java.awt.GridBagConstraints;
+import java.awt.GridBagLayout;
 import java.awt.event.ActionEvent;
 import java.awt.event.KeyEvent;

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/io/download/MapillaryDownloader.java

@@ -104 +104 @@
     if (isViewDownloaded(view))
       return;
-    MapillaryLayer.getInstance().getData().bounds.add(view);
+    MapillaryLayer.getInstance().getData().getBounds().add(view);
     getImages(view);
   }
@@ -139 +139 @@
    */
   private static boolean isInBounds(LatLon latlon) {
-    for (Bounds bounds : MapillaryLayer.getInstance().getData().bounds) {
+    for (Bounds bounds : MapillaryLayer.getInstance().getData().getBounds()) {
       if (bounds.contains(latlon))
         return true;
@@ -162 +162 @@
     for (Bounds bounds : Main.map.mapView.getEditLayer().data
         .getDataSourceBounds()) {
-      if (!layer.getData().bounds.contains(bounds)) {
-        layer.getData().bounds.add(bounds);
+      if (!layer.getData().getBounds().contains(bounds)) {
+        layer.getData().getBounds().add(bounds);
         MapillaryDownloader.getImages(bounds.getMin(), bounds.getMax());
       }

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/io/download/MapillarySequenceDownloadThread.java

@@ -127 +127 @@
 
   private static boolean isInside(MapillaryAbstractImage image) {
-    for (Bounds b : MapillaryLayer.getInstance().getData().bounds) {
+    for (Bounds b : MapillaryLayer.getInstance().getData().getBounds()) {
       if (b.contains(image.getLatLon())) {
         return true;

applications/editors/josm/plugins/mapillary/src/org/openstreetmap/josm/plugins/mapillary/utils/MapillaryURL.java

@@ -26 +26 @@
   /**
    * Gives you the URL for the online editor of a specific mapillary image.
-   * @param key the key of the image to which you want to link
+   * @param imgKey the key of the image to which you want to link
    * @return the URL of the online editor for the image with the given image key
+   * @throws IllegalArgumentException if the image key is <code>null</code> or invalid according
+   *           to {@link ValidationUtil#validateImageKey(String)}
    */
-  public static URL browseEditURL(String key) {
-    if (key == null || !key.matches("[a-zA-Z0-9\\-_]{22}")) {
-      throw new IllegalArgumentException("Invalid image key");
-    }
-    return string2URL(BASE_WEBSITE_URL + "map/e/" + key);
+  public static URL browseEditURL(String imgKey) {
+    ValidationUtil.throwExceptionForInvalidImgKey(imgKey, false);
+    return string2URL(BASE_WEBSITE_URL + "map/e/" + imgKey);
   }
 
@@ -40 +40 @@
    * @param key the key of the image to which you want to link
    * @return the URL of the online viewer for the image with the given image key
+   * @throws IllegalArgumentException if the image key is <code>null</code> or invalid according
+   *           to {@link ValidationUtil#validateImageKey(String)}
    */
   public static URL browseImageURL(String key) {
-    if (key == null || !key.matches("[a-zA-Z0-9\\-_]{22}")) {
-      throw new IllegalArgumentException("Invalid image key");
-    }
+    ValidationUtil.throwExceptionForInvalidImgKey(key, false);
     return string2URL(BASE_WEBSITE_URL + "map/im/" + key);
   }

applications/editors/josm/plugins/mapillary/test/unit/org/openstreetmap/josm/plugins/mapillary/io/download/MapillarySequenceDownloadThreadTest.java

@@ -40 +40 @@
     ExecutorService ex = Executors.newSingleThreadExecutor();
     Bounds bounds = new Bounds(minLatLon, maxLatLon);
-    MapillaryLayer.getInstance().getData().bounds.add(new Bounds(minLatLon,
+    MapillaryLayer.getInstance().getData().getBounds().add(new Bounds(minLatLon,
         maxLatLon));