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

Timestamp:

2012-08-13T02:37:03+02:00 (12 years ago)

Author:

Don-vip

Message:

fix #7716 - History shows same version number, wrong date, user, and CT for modified objects

Location:

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

Files:

• HistoryNode.java (modified) (2 diffs)
• HistoryOsmPrimitive.java (modified) (2 diffs)
• HistoryRelation.java (modified) (3 diffs)
• HistoryWay.java (modified) (2 diffs)

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

@@ -15 +15 @@
  */
 public class HistoryNode extends HistoryOsmPrimitive {
+    
     /** the coordinates. May be null for deleted nodes */
-
     private LatLon coords;
 
-    public HistoryNode(long id, long version, boolean visible, User user, long changesetId, Date timestamp, LatLon coords) {
-        super(id, version, visible, user, changesetId, timestamp);
+    /**
+     * Constructs a new {@code HistoryNode}.
+     * 
+     * @param id the id (> 0 required)
+     * @param version the version (> 0 required)
+     * @param visible whether the node is still visible
+     * @param user the user (! null required)
+     * @param changesetId the changeset id (> 0 required)
+     * @param timestamp the timestamp (! null required)
+     * @param coords the coordinates
+     * @throws IllegalArgumentException if preconditions are violated
+     */
+    public HistoryNode(long id, long version, boolean visible, User user, long changesetId, Date timestamp, LatLon coords) throws IllegalArgumentException {
+        this(id, version, visible, user, changesetId, timestamp, coords, true);
+    }
+
+    /**
+     * Constructs a new {@code HistoryNode} with a configurable checking of historic parameters.
+     * This is needed to build virtual HistoryNodes for modified nodes, which do not have a timestamp and a changeset id.
+     * 
+     * @param id the id (> 0 required)
+     * @param version the version (> 0 required)
+     * @param visible whether the node is still visible
+     * @param user the user (! null required)
+     * @param changesetId the changeset id (> 0 required if {@code checkHistoricParams} is true)
+     * @param timestamp the timestamp (! null required if {@code checkHistoricParams} is true)
+     * @param coords the coordinates
+     * @param checkHistoricParams if true, checks values of {@code changesetId} and {@code timestamp}
+     * @throws IllegalArgumentException if preconditions are violated
+     * @since 5440
+     */
+    public HistoryNode(long id, long version, boolean visible, User user, long changesetId, Date timestamp, LatLon coords, boolean checkHistoricParams) throws IllegalArgumentException {
+        super(id, version, visible, user, changesetId, timestamp, checkHistoricParams);
         setCoords(coords);
     }
 
-    public HistoryNode(Node p) {
-        super(p);
-        setCoords(p.getCoor());
+    /**
+     * Constructs a new {@code HistoryNode} from an existing {@link Node}.
+     * @param n the node
+     */
+    public HistoryNode(Node n) {
+        super(n);
+        setCoords(n.getCoor());
     }
 
@@ -34 +69 @@
     }
 
+    /**
+     * Replies the coordinates. May be null.
+     * @return the coordinates. May be null.
+     */
     public LatLon getCoords() {
         return coords;
     }
 
+    /**
+     * Sets the coordinates. Can be null.
+     * @param coords the coordinates. Can be null.
+     */
     public void setCoords(LatLon coords) {
         this.coords = coords;

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

@@ -42 +42 @@
 
     /**
-     * constructor
-     *
-     * @param id the id (>0 required)
+     * Constructs a new {@code HistoryOsmPrimitive}.
+     *
+     * @param id the id (> 0 required)
      * @param version the version (> 0 required)
      * @param visible whether the primitive is still visible
-     * @param user  the user (! null required)
-     * @param uid the user id (> 0 required)
-     * @param changesetId the changeset id (may be null if the changeset isn't known)
+     * @param user the user (! null required)
+     * @param changesetId the changeset id (> 0 required)
      * @param timestamp the timestamp (! null required)
      *
-     * @throws IllegalArgumentException thrown if preconditions are violated
+     * @throws IllegalArgumentException if preconditions are violated
      */
     public HistoryOsmPrimitive(long id, long version, boolean visible, User user, long changesetId, Date timestamp) throws IllegalArgumentException {
+        this(id, version, visible, user, changesetId, timestamp, true);
+    }
+
+    /**
+     * Constructs a new {@code HistoryOsmPrimitive} with a configurable checking of historic parameters.
+     * This is needed to build virtual HistoryOsmPrimitives for modified primitives, which do not have a timestamp and a changeset id.
+     *
+     * @param id the id (> 0 required)
+     * @param version the version (> 0 required)
+     * @param visible whether the primitive is still visible
+     * @param user the user (! null required)
+     * @param changesetId the changeset id (> 0 required if {@code checkHistoricParams} is true)
+     * @param timestamp the timestamp (! null required if {@code checkHistoricParams} is true)
+     * @param checkHistoricParams if true, checks values of {@code changesetId} and {@code timestamp}
+     *
+     * @throws IllegalArgumentException if preconditions are violated
+     * @since 5440
+     */
+    public HistoryOsmPrimitive(long id, long version, boolean visible, User user, long changesetId, Date timestamp, boolean checkHistoricParams) throws IllegalArgumentException {
         ensurePositiveLong(id, "id");
         ensurePositiveLong(version, "version");
         CheckParameterUtil.ensureParameterNotNull(user, "user");
-        CheckParameterUtil.ensureParameterNotNull(timestamp, "timestamp");
+        if (checkHistoricParams) {
+            ensurePositiveLong(changesetId, "changesetId");
+            CheckParameterUtil.ensureParameterNotNull(timestamp, "timestamp");
+        }
         this.id = id;
         this.version = version;
         this.visible = visible;
         this.user = user;
-        // FIXME: restrict to IDs > 0 as soon as OsmPrimitive holds the
-        // changeset id too
         this.changesetId  = changesetId;
         this.timestamp = timestamp;
         tags = new HashMap<String, String>();
     }
-
+    
+    /**
+     * Constructs a new {@code HistoryOsmPrimitive} from an existing {@link OsmPrimitive}.
+     * @param p the primitive
+     */
     public HistoryOsmPrimitive(OsmPrimitive p) {
-        this(p.getId(), p.getVersion(), p.isVisible(),
-                p.getUser(),
-                p.getChangesetId(), p.getTimestamp());
-    }
-
+        this(p.getId(), p.getVersion(), p.isVisible(), p.getUser(), p.getChangesetId(), p.getTimestamp());
+    }
+
+    /**
+     * Replies a new {@link HistoryNode}, {@link HistoryWay} or {@link HistoryRelation} from an existing {@link OsmPrimitive}.
+     * @param p the primitive
+     * @return a new {@code HistoryNode}, {@code HistoryWay} or {@code HistoryRelation} from {@code p}.
+     */
     public static HistoryOsmPrimitive forOsmPrimitive(OsmPrimitive p) {
         if (p instanceof Node) {
@@ -173 +199 @@
     /**
      * Replies the display name of a primitive formatted by <code>formatter</code>
+     * @param formatter The formatter used to generate a display name
      *
      * @return the display name

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

@@ -30 +30 @@
      * @param visible whether the primitive is still visible
      * @param user  the user (! null required)
-     * @param uid the user id (> 0 required)
      * @param changesetId the changeset id (> 0 required)
      * @param timestamp the timestamp (! null required)
      *
-     * @throws IllegalArgumentException thrown if preconditions are violated
+     * @throws IllegalArgumentException if preconditions are violated
      */
-    public HistoryRelation(long id, long version, boolean visible, User user, long changesetId,
-            Date timestamp) throws IllegalArgumentException {
+    public HistoryRelation(long id, long version, boolean visible, User user, long changesetId, Date timestamp) throws IllegalArgumentException {
         super(id, version, visible, user, changesetId, timestamp);
     }
+
     /**
      * constructor
@@ -47 +46 @@
      * @param visible whether the primitive is still visible
      * @param user  the user (! null required)
-     * @param uid the user id (> 0 required)
+     * @param changesetId the changeset id (> 0 required if {@code checkHistoricParams} is true)
+     * @param timestamp the timestamp (! null required if {@code checkHistoricParams} is true)
+     * @param checkHistoricParams If true, checks values of {@code changesetId} and {@code timestamp}
+     *
+     * @throws IllegalArgumentException if preconditions are violated
+     * @since 5440
+     */
+    public HistoryRelation(long id, long version, boolean visible, User user, long changesetId, Date timestamp, boolean checkHistoricParams) throws IllegalArgumentException {
+        super(id, version, visible, user, changesetId, timestamp, checkHistoricParams);
+    }
+
+    /**
+     * constructor
+     *
+     * @param id the id (>0 required)
+     * @param version the version (> 0 required)
+     * @param visible whether the primitive is still visible
+     * @param user  the user (! null required)
      * @param changesetId the changeset id (> 0 required)
      * @param timestamp the timestamp (! null required)
@@ -62 +78 @@
     }
 
-    public HistoryRelation(Relation p) {
-        super(p);
+    /**
+     * Constructs a new {@code HistoryRelation} from an existing {@link Relation}.
+     * @param r the relation
+     */
+    public HistoryRelation(Relation r) {
+        super(r);
     }
 

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

@@ -12 +12 @@
 import org.openstreetmap.josm.data.osm.User;
 import org.openstreetmap.josm.data.osm.Way;
+import org.openstreetmap.josm.tools.CheckParameterUtil;
 
 /**
@@ -22 +23 @@
     private ArrayList<Long> nodeIds = new ArrayList<Long>();
 
-    public HistoryWay(long id, long version, boolean visible, User user, long changesetId, Date timestamp) {
+    /**
+     * Constructs a new {@code HistoryWay}.
+     * 
+     * @param id the id (> 0 required)
+     * @param version the version (> 0 required)
+     * @param visible whether the node is still visible
+     * @param user the user (! null required)
+     * @param changesetId the changeset id (> 0 required if {@code checkHistoricParams} is true)
+     * @param timestamp the timestamp (! null required if {@code checkHistoricParams} is true)
+     * @throws IllegalArgumentException if preconditions are violated
+     */
+    public HistoryWay(long id, long version, boolean visible, User user, long changesetId, Date timestamp) throws IllegalArgumentException {
         super(id, version, visible, user, changesetId, timestamp);
     }
 
-    public HistoryWay(long id, long version, boolean visible, User user, long changesetId, Date timestamp, ArrayList<Long> nodeIdList) {
+    /**
+     * Constructs a new {@code HistoryWay} with a configurable checking of historic parameters.
+     * This is needed to build virtual HistoryWays for modified ways, which do not have a timestamp and a changeset id.
+     * 
+     * @param id the id (> 0 required)
+     * @param version the version (> 0 required)
+     * @param visible whether the node is still visible
+     * @param user the user (! null required)
+     * @param changesetId the changeset id (> 0 required if {@code checkHistoricParams} is true)
+     * @param timestamp the timestamp (! null required if {@code checkHistoricParams} is true)
+     * @param checkHistoricParams if true, checks values of {@code changesetId} and {@code timestamp}
+     * @throws IllegalArgumentException if preconditions are violated
+     * @since 5440
+     */
+    public HistoryWay(long id, long version, boolean visible, User user, long changesetId, Date timestamp, boolean checkHistoricParams) throws IllegalArgumentException {
+        super(id, version, visible, user, changesetId, timestamp, checkHistoricParams);
+    }
+
+    /**
+     * Constructs a new {@code HistoryWay} with a given list of node ids.
+     * 
+     * @param id the id (> 0 required)
+     * @param version the version (> 0 required)
+     * @param visible whether the node is still visible
+     * @param user the user (! null required)
+     * @param changesetId the changeset id (> 0 required if {@code checkHistoricParams} is true)
+     * @param timestamp the timestamp (! null required if {@code checkHistoricParams} is true)
+     * @param nodeIdList the node ids (! null required)
+     * @throws IllegalArgumentException if preconditions are violated
+     */
+    public HistoryWay(long id, long version, boolean visible, User user, long changesetId, Date timestamp, ArrayList<Long> nodeIdList) throws IllegalArgumentException {
         this(id, version, visible, user, changesetId, timestamp);
+        CheckParameterUtil.ensureParameterNotNull(nodeIdList, "nodeIdList");
         this.nodeIds.addAll(nodeIdList);
     }
 
-    public HistoryWay(Way p) {
-        super(p);
+    /**
+     * Constructs a new {@code HistoryWay} from an existing {@link Way}.
+     * @param w the way
+     */
+    public HistoryWay(Way w) {
+        super(w);
     }