Changeset 2410 in josm for trunk

Timestamp:

2009-11-08T15:19:50+01:00 (15 years ago)

Author:

jttt

Message:

Add clearId parameter to primitives copy constructor, replace some clearOsmId calls, throw exception if id is set after primitive was added to the dataset

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/UnGlueAction.java (modified) (3 diffs)
• command/UndeletePrimitivesCommand.java (modified) (4 diffs)
• data/osm/Node.java (modified) (1 diff)
• data/osm/OsmPrimitive.java (modified) (3 diffs)
• data/osm/Relation.java (modified) (1 diff)
• data/osm/Way.java (modified) (1 diff)
• gui/dialogs/RelationListDialog.java (modified) (1 diff)
• io/OsmReader.java (modified) (1 diff)

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

@@ -2 +2 @@
 package org.openstreetmap.josm.actions;
 
+import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
 import static org.openstreetmap.josm.tools.I18n.tr;
-import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
 
 import java.awt.event.ActionEvent;
@@ -157 +157 @@
         cmds.add(new ChangeCommand(selectedNode, c));
 
-        Node n = new Node(selectedNode);
-        n.clearOsmId();
+        Node n = new Node(selectedNode, true);
 
         // If this wasn't called from menu, place it where the cursor is/was
@@ -302 +301 @@
             if (originalNode == pushNode) {
                 // clone the node for all other ways
-                pushNode = new Node(pushNode);
-                pushNode.clearOsmId();
+                pushNode = new Node(pushNode, true);
                 newNodes.add(pushNode);
                 cmds.add(new AddCommand(pushNode));

trunk/src/org/openstreetmap/josm/command/UndeletePrimitivesCommand.java

@@ -6 +6 @@
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.List;
 import java.util.logging.Logger;
 
@@ -25 +26 @@
 
     /** the node to undelete */
-    private ArrayList<OsmPrimitive> toUndelete;
+    private final List<OsmPrimitive> toUndelete = new ArrayList<OsmPrimitive>();
 
-    protected UndeletePrimitivesCommand() {
-        toUndelete = new ArrayList<OsmPrimitive>();
-    }
     /**
      * constructor
@@ -35 +33 @@
      */
     public UndeletePrimitivesCommand(OsmPrimitive node) {
-        this();
         toUndelete.add(node);
     }
@@ -44 +41 @@
      */
     public UndeletePrimitivesCommand(OsmPrimitive ... toUndelete) {
-        this();
         for (int i=0; i < toUndelete.length; i++) {
             this.toUndelete.add(toUndelete[i]);

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

@@ -68 +68 @@
 
     /**
+     * 
+     * @param clone
+     * @param clearId If true, set version to 0 and id to new unique value
+     */
+    public Node(Node clone, boolean clearId) {
+        super(clone.getUniqueId(), true);
+        cloneFrom(clone);
+        if (clearId) {
+            clearOsmId();
+        }
+    }
+
+    /**
      * Create an identical clone of the argument (including the id)
      */
     public Node(Node clone) {
-        super(clone.getUniqueId(), true);
-        cloneFrom(clone);
+        this(clone, false);
     }
 

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

@@ -378 +378 @@
      * @throws IllegalArgumentException thrown if id <= 0
      * @throws IllegalArgumentException thrown if version <= 0
+     * @throws DataIntegrityProblemException If id is changed and primitive was already added to the dataset
      */
     public void setOsmId(long id, int version) {
@@ -384 +385 @@
         if (version <= 0)
             throw new IllegalArgumentException(tr("Version > 0 expected. Got {0}.", version));
+        if (dataSet != null && id != this.id)
+            throw new DataIntegrityProblemException("Id cannot be changed after primitive was added to the dataset");
         this.id = id;
         this.version = version;
@@ -391 +394 @@
     /**
      * Clears the id and version known to the OSM API. The id and the version is set to 0.
-     * incomplete is set to false.
+     * incomplete is set to false. It's preferred to use copy constructor with clearId set to true instead
+     * of calling this method.
      *
      * <strong>Caution</strong>: Do not use this method on primitives which are already added to a {@see DataSet}.
-     * Ways and relations might already refer to the primitive and clearing the OSM ID
-     * result in corrupt data.
-     *
-     * Here's an example use case:
-     * <pre>
-     *     // create a clone of an already existing node
-     *     Node copy = new Node(otherExistingNode);
-     *
-     *     // reset the clones OSM id
-     *     copy.clearOsmId();
-     * </pre>
-     *
+     *
+     * @throws DataIntegrityProblemException If primitive was already added to the dataset
      */
     public void clearOsmId() {
+        if (dataSet != null)
+            throw new DataIntegrityProblemException("Method cannot be called after primitive was added to the dataset");
         this.id = generateUniqueId();
         this.version = 0;

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

@@ -140 +140 @@
     }
 
-    /**
-     * Create an identical clone of the argument (including the id)
-     */
-    public Relation(Relation clone) {
+    public Relation(Relation clone, boolean clearId) {
         super(clone.getUniqueId(), true);
         cloneFrom(clone);
+        if (clearId) {
+            clearOsmId();
+        }
+    }
+
+    /**
+     * Create an identical clone of the argument (including the id)
+     */
+    public Relation(Relation clone) {
+        this(clone, false);
     }
 

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

@@ -149 +149 @@
 
     /**
-     * Create an identical clone of the argument (including the id).
-     *
-     * @param original  the original way. Must not be null.
-     */
-    public Way(Way original) {
+     * 
+     * @param original
+     * @param clearId
+     */
+    public Way(Way original, boolean clearId) {
         super(original.getUniqueId(), true);
         cloneFrom(original);
+        if (clearId) {
+            clearOsmId();
+        }
+    }
+
+    /**
+     * Create an identical clone of the argument (including the id).
+     *
+     * @param original  the original way. Must not be null.
+     */
+    public Way(Way original) {
+        this(original, false);
     }
 

trunk/src/org/openstreetmap/josm/gui/dialogs/RelationListDialog.java

@@ -471 +471 @@
 
         public void launchEditorForDuplicate(Relation original) {
-            Relation copy = new Relation(original.getId());
-            copy.cloneFrom(original);
-            copy.clearOsmId();
+            Relation copy = new Relation(original, true);
             copy.setModified(true);
             RelationEditor editor = RelationEditor.getEditor(

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

@@ -92 +92 @@
 
         public void copyTo(OsmPrimitive osm) {
-            //  id < 0 possible if read from a file
-            if (id <= 0) {
-                osm.clearOsmId();
-            } else {
+            // It's not necessary to call clearOsmId for id < 0. The same thing is done by parameterless constructor
+            if (id > 0) {
                 osm.setOsmId(id, version);
             }