Changeset 2448 in josm for trunk/src/org/openstreetmap/josm/data/osm

Timestamp:

2009-11-14T17:59:10+01:00 (15 years ago)

Author:

Gubaer

Message:

fixed #3352: History doesn't get invalidated on upload?
fixed #3912: Extend history dialog to contain the currently modified version
new: zoom to node in list of nodes in history dialog (popup menu)
new: load history of node from node list in history dialog (popup menu or double click)
fixed: close all history dialogs when the number of layers drop to 0
fixed: implemented equals() and hashCode() on SimplePrimitiveId
fixed: history features now usePrimitiveId instead of long.

Location:

trunk/src/org/openstreetmap/josm/data/osm

Files:

• OsmPrimitive.java (modified) (2 diffs)
• SimplePrimitiveId.java (modified) (1 diff)
• history/History.java (modified) (10 diffs)
• history/HistoryDataSet.java (modified) (7 diffs)
• history/HistoryDataSetListener.java (modified) (1 diff)
• history/HistoryOsmPrimitive.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/data/osm/OsmPrimitive.java

@@ -811 +811 @@
      * @throws IllegalArgumentException thrown if other is null.
      * @throws DataIntegrityProblemException thrown if either this is new and other is not, or other is new and this is not
-     * @throws DataIntegrityProblemException thrown if other is new and other.getId() != this.getId()
+     * @throws DataIntegrityProblemException thrown if other isn't new and other.getId() != this.getId()
      */
     public void mergeFrom(OsmPrimitive other) {
@@ -1025 +1025 @@
     public abstract void updatePosition();
 
+    /**
+     * Replies the unique primitive id for this primitive
+     * 
+     * @return the unique primitive id for this primitive
+     */
+    public PrimitiveId getPrimitiveId() {
+        return new SimplePrimitiveId(getUniqueId(), getType());
+    }
 }
 

trunk/src/org/openstreetmap/josm/data/osm/SimplePrimitiveId.java

@@ -20 +20 @@
     }
 
+    @Override
+    public int hashCode() {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result + (int) (id ^ (id >>> 32));
+        result = prime * result + ((type == null) ? 0 : type.hashCode());
+        return result;
+    }
 
-
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj)
+            return true;
+        if (obj == null)
+            return false;
+        if (getClass() != obj.getClass())
+            return false;
+        SimplePrimitiveId other = (SimplePrimitiveId) obj;
+        if (id != other.id)
+            return false;
+        if (type == null) {
+            if (other.type != null)
+                return false;
+        } else if (!type.equals(other.type))
+            return false;
+        return true;
+    }
 }

trunk/src/org/openstreetmap/josm/data/osm/history/History.java

@@ -9 +9 @@
 import java.util.Date;
 import java.util.List;
-import java.util.NoSuchElementException;
 
 import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
-
+import org.openstreetmap.josm.data.osm.PrimitiveId;
+import org.openstreetmap.josm.data.osm.SimplePrimitiveId;
+
+/**
+ * Represents the history of an OSM primitive. The history consists
+ * of a list of object snapshots with a specific version.
+ * 
+ */
 public class History{
     private static interface FilterPredicate {
@@ -25 +31 @@
             }
         }
-        return new History(history.id, out);
-    }
-
+        return new History(history.id, history.type,out);
+    }
+
+    /** the list of object snapshots */
     private ArrayList<HistoryOsmPrimitive> versions;
-    long id;
-
-    protected History(long id, List<HistoryOsmPrimitive> versions) {
+    /** the object id */
+    private long id;
+    private OsmPrimitiveType type;
+
+    /**
+     * Creates a new history for an OSM primitive
+     * 
+     * @param id the id. >0 required.
+     * @param type the primitive type. Must not be null.
+     * @param versions a list of versions. Can be null.
+     * @throws IllegalArgumentException thrown if id <= 0
+     * @throws IllegalArgumentException if type is null
+     * 
+     */
+    protected History(long id, OsmPrimitiveType type, List<HistoryOsmPrimitive> versions) {
+        if (id <= 0)
+            throw new IllegalArgumentException(tr("Parameter ''{0}'' > 0 expected, got {1}", "id", id));
+        if (type == null)
+            throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null", "type"));
         this.id = id;
+        this.type = type;
         this.versions = new ArrayList<HistoryOsmPrimitive>();
-        this.versions.addAll(versions);
+        if (versions != null) {
+            this.versions.addAll(versions);
+        }
     }
 
@@ -47 +73 @@
                 }
         );
-        return new History(id, copy);
+        return new History(id, type, copy);
     }
 
@@ -60 +86 @@
                 }
         );
-        return new History(id, copy);
+        return new History(id, type,copy);
     }
 
@@ -139 +165 @@
     public long getId() {
         return id;
+    }
+
+    /**
+     * Replies the primitive id for this history.
+     * 
+     * @return the primitive id
+     */
+    public PrimitiveId getPrimitmiveId() {
+        return new SimplePrimitiveId(id, type);
     }
 
@@ -149 +184 @@
     }
 
+    /**
+     * Replies the history primitive with version <code>version</code>. null,
+     * if no such primitive exists.
+     * 
+     * @param version the version
+     * @return the history primitive with version <code>version</code>
+     */
     public HistoryOsmPrimitive getByVersion(long version) {
         for (HistoryOsmPrimitive primitive: versions) {
@@ -154 +196 @@
                 return primitive;
         }
-        throw new NoSuchElementException(tr("There's no primitive with version {0} in this history.", version));
+        return null;
     }
 
     public HistoryOsmPrimitive getByDate(Date date) {
-        sortAscending();
-
-        if (versions.isEmpty())
-            throw new NoSuchElementException(tr("There's no version valid at date ''{0}'' in this history.", date));
-        if (get(0).getTimestamp().compareTo(date)> 0)
-            throw new NoSuchElementException(tr("There's no version valid at date ''{0}'' in this history.", date));
-        for (int i = 1; i < versions.size();i++) {
-            if (get(i-1).getTimestamp().compareTo(date) <= 0
-                    && get(i).getTimestamp().compareTo(date) >= 0)
-                return get(i);
-        }
-        return getLatest();
+        History h = sortAscending();
+
+        if (h.versions.isEmpty())
+            return null;
+        if (h.get(0).getTimestamp().compareTo(date)> 0)
+            return null;
+        for (int i = 1; i < h.versions.size();i++) {
+            if (h.get(i-1).getTimestamp().compareTo(date) <= 0
+                    && h.get(i).getTimestamp().compareTo(date) >= 0)
+                return h.get(i);
+        }
+        return h.getLatest();
     }
 
@@ -180 +222 @@
     public HistoryOsmPrimitive getEarliest() {
         if (isEmpty())
-            throw new NoSuchElementException(tr("No earliest version found. History is empty."));
+            return null;
         return sortAscending().versions.get(0);
     }
@@ -186 +228 @@
     public HistoryOsmPrimitive getLatest() {
         if (isEmpty())
-            throw new NoSuchElementException(tr("No latest version found. History is empty."));
+            return null;
         return sortDescending().versions.get(0);
     }
@@ -199 +241 @@
 
     public OsmPrimitiveType getType() {
-        if (isEmpty())
-            throw new NoSuchElementException(tr("No type found. History is empty."));
-        return versions.get(0).getType();
+        return type;
     }
 }

trunk/src/org/openstreetmap/josm/data/osm/history/HistoryDataSet.java

@@ -6 +6 @@
 import java.util.ArrayList;
 import java.util.HashMap;
-import java.util.NoSuchElementException;
 import java.util.concurrent.CopyOnWriteArrayList;
+import java.util.logging.Logger;
+
+import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
+import org.openstreetmap.josm.data.osm.PrimitiveId;
+import org.openstreetmap.josm.data.osm.SimplePrimitiveId;
 
 /**
@@ -15 +19 @@
  */
 public class HistoryDataSet {
+    private final static Logger logger = Logger.getLogger(HistoryDataSet.class.getName());
 
     /** the unique instance */
@@ -32 +37 @@
 
     /** the history data */
-    private HashMap<Long, ArrayList<HistoryOsmPrimitive>> data;
+    private HashMap<PrimitiveId, ArrayList<HistoryOsmPrimitive>> data;
     private CopyOnWriteArrayList<HistoryDataSetListener> listeners;
 
     public HistoryDataSet() {
-        data = new HashMap<Long, ArrayList<HistoryOsmPrimitive>>();
+        data = new HashMap<PrimitiveId, ArrayList<HistoryOsmPrimitive>>();
         listeners = new CopyOnWriteArrayList<HistoryDataSetListener>();
     }
@@ -56 +61 @@
     }
 
-    protected void fireHistoryUpdated(long id) {
+    protected void fireHistoryUpdated(SimplePrimitiveId id) {
         for (HistoryDataSetListener l : listeners) {
             l.historyUpdated(this, id);
@@ -64 +69 @@
     /**
      * Replies the history primitive for the primitive with id <code>id</code>
-     * and version <code>version</code>
+     * and version <code>version</code>. null, if no such primitive exists.
      * 
-     * @param id the id of the primitive
-     * @param version the version of the primitive
-     * @return the history primitive for the primitive with id <code>id</code>
-     * and version <code>version</code>
-     * @throws NoSuchElementException thrown if this dataset doesn't include the respective
-     * history primitive
+     * @param id the id of the primitive. > 0 required.
+     * @param type the primitive type. Must not be null.
+     * @param version the version of the primitive. > 0 required
+     * @return the history primitive for the primitive with id <code>id</code>,
+     * type <code>type</code>, and version <code>version</code>
      */
-    public HistoryOsmPrimitive get(long id, long version) throws NoSuchElementException{
-        ArrayList<HistoryOsmPrimitive> versions = data.get(id);
+    public HistoryOsmPrimitive get(long id, OsmPrimitiveType type, long version){
+        if (id <= 0)
+            throw new IllegalArgumentException(tr("Parameter ''{0}'' > 0 expected, got {1}", "id", id));
+        if (type == null)
+            throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null", "type"));
+        if (version <= 0)
+            throw new IllegalArgumentException(tr("Parameter ''{0}'' > 0 expected, got {1}", "version", version));
+
+        SimplePrimitiveId pid = new SimplePrimitiveId(id, type);
+        ArrayList<HistoryOsmPrimitive> versions = data.get(pid);
         if (versions == null)
-            throw new NoSuchElementException(tr("Didn't find an primitive with id {0} in this dataset", id));
-
+            return null;
         for (HistoryOsmPrimitive primitive: versions) {
             if (primitive.matches(id, version))
                 return primitive;
         }
-        throw new NoSuchElementException(tr("Didn't find an primitive with id {0} and version {1} in this dataset", id, version));
+        return null;
     }
 
@@ -91 +102 @@
      */
     public void put(HistoryOsmPrimitive primitive) {
-        if (data.get(primitive.getId()) == null) {
-            data.put(primitive.getId(), new ArrayList<HistoryOsmPrimitive>());
+        SimplePrimitiveId id = new SimplePrimitiveId(primitive.getId(), primitive.getType());
+        if (data.get(id) == null) {
+            data.put(id, new ArrayList<HistoryOsmPrimitive>());
         }
-        data.get(primitive.getId()).add(primitive);
-        fireHistoryUpdated(primitive.getId());
+        data.get(id).add(primitive);
+        fireHistoryUpdated(id);
     }
 
     /**
      * Replies the history for a given primitive with id <code>id</code>
+     * and type <code>type</code>.
      * 
-     * @param id the id
-     * @return the history
+     * @param id the id the if of the primitive. > 0 required
+     * @param type the type of the primitive. Must not be null.
+     * @return the history. null, if there isn't a history for <code>id</code> and
+     * <code>type</code>.
+     * @throws IllegalArgumentException thrown if id <= 0
+     * @throws IllegalArgumentException thrown if type is null
      */
-    public History getHistory(long id) {
-        ArrayList<HistoryOsmPrimitive> versions = data.get(id);
+    public History getHistory(long id, OsmPrimitiveType type) throws IllegalArgumentException{
+        if (id <= 0)
+            throw new IllegalArgumentException(tr("Parameter ''{0}'' > 0 expected, got {1}", "id", id));
+        if (type == null)
+            throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null", "type"));
+        SimplePrimitiveId pid = new SimplePrimitiveId(id, type);
+        return getHistory(pid);
+    }
+
+    /**
+     * Replies the history for a primitive with id <code>id</code>. null, if no
+     * such history exists.
+     * 
+     * @param pid the primitive id. Must not be null.
+     * @return the history for a primitive with id <code>id</code>. null, if no
+     * such history exists
+     * @throws IllegalArgumentException thrown if pid is null
+     */
+    public History getHistory(PrimitiveId pid) throws IllegalArgumentException{
+        if (pid == null)
+            throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null", "pid"));
+        ArrayList<HistoryOsmPrimitive> versions = data.get(pid);
         if (versions == null)
             return null;
-        return new History(id, versions);
+        return new History(pid.getUniqueId(), pid.getType(), versions);
     }
 
@@ -119 +156 @@
         if (other == null)
             return;
-        for (Long id : other.data.keySet()) {
+        for (PrimitiveId id : other.data.keySet()) {
             this.data.put(id, other.data.get(id));
         }
-        fireHistoryUpdated(0);
+        fireHistoryUpdated(null);
     }
 }

trunk/src/org/openstreetmap/josm/data/osm/history/HistoryDataSetListener.java

@@ -2 +2 @@
 package org.openstreetmap.josm.data.osm.history;
 
+import org.openstreetmap.josm.data.osm.PrimitiveId;
+
 public interface HistoryDataSetListener {
-    void historyUpdated(HistoryDataSet source, long primitiveId);
+    void historyUpdated(HistoryDataSet source, PrimitiveId id);
 }

trunk/src/org/openstreetmap/josm/data/osm/history/HistoryOsmPrimitive.java

@@ -10 +10 @@
 
 import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
+import org.openstreetmap.josm.data.osm.PrimitiveId;
+import org.openstreetmap.josm.data.osm.SimplePrimitiveId;
 
 /**
@@ -45 +47 @@
      * @param user  the user (! null required)
      * @param uid the user id (> 0 required)
-     * @param changesetId the changeset id (> 0 required)
+     * @param changesetId the changeset id (may be null if the changeset isn't known)
      * @param timestamp the timestamp (! null required)
      *
@@ -53 +55 @@
         ensurePositiveLong(id, "id");
         ensurePositiveLong(version, "version");
-        if(uid != -1) /* allow -1 for anonymous users */
+        if(uid != -1) {
             ensurePositiveLong(uid, "uid");
-        ensurePositiveLong(changesetId, "changesetId");
+        }
         ensureNotNull(user, "user");
         ensureNotNull(timestamp, "timestamp");
@@ -63 +65 @@
         this.user = user;
         this.uid = uid;
+        // FIXME: restrict to IDs > 0 as soon as OsmPrimitive holds the
+        // changeset id too
         this.changesetId  = changesetId;
         this.timestamp = timestamp;
@@ -71 +75 @@
         return id;
     }
+
+    public PrimitiveId getPrimitiveId() {
+        return new SimplePrimitiveId(id, getType());
+    }
+
     public boolean isVisible() {
         return visible;
@@ -103 +112 @@
     public int compareTo(HistoryOsmPrimitive o) {
         if (this.id != o.id)
-            throw new ClassCastException(tr("Can't compare primitive with ID ''{0}'' to primitive with ID ''{1}''.", o.id, this.id));
+            throw new ClassCastException(tr("Can''t compare primitive with ID ''{0}'' to primitive with ID ''{1}''.", o.id, this.id));
         return new Long(this.version).compareTo(o.version);
     }
@@ -121 +130 @@
     public Map<String,String> getTags() {
         return Collections.unmodifiableMap(tags);
+    }
+
+    /**
+     * Sets the tags for this history primitive. Removes all
+     * tags if <code>tags</code> is null.
+     * 
+     * @param tags the tags. May be null.
+     */
+    public void setTags(Map<String,String> tags) {
+        if (tags == null) {
+            this.tags = new HashMap<String, String>();
+        } else {
+            this.tags = new HashMap<String, String>(tags);
+        }
     }