Changeset 2070 in josm for trunk/src/org/openstreetmap/josm/data/osm/OsmPrimitive.java

Timestamp:

2009-09-06T23:07:33+02:00 (15 years ago)

Author:

Gubaer

Message:

new: rewrite of CombineWay action
new: conflict resolution dialog for CombineWay, including conflicts for different relation memberships
cleanup: cleanup in OsmReader, reduces memory footprint and reduces parsing time
cleanup: made most of the public fields in OsmPrimitive @deprecated, added accessors and changed the code
cleanup: replaced usages of @deprecated constructors for ExtendedDialog
fixed #3208: Combine ways brokes relation order

WARNING: this changeset touches a lot of code all over the code base. "latest" might become slightly unstable in the next days. Also experience incompatibility issues with plugins in the next few days.

File:

• trunk/src/org/openstreetmap/josm/data/osm/OsmPrimitive.java (modified) (9 diffs)

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

@@ -10 +10 @@
 import java.util.Date;
 import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedList;
+import java.util.List;
 import java.util.Locale;
 import java.util.Map;
+import java.util.Set;
 import java.util.Map.Entry;
 
@@ -31 +35 @@
 abstract public class OsmPrimitive implements Comparable<OsmPrimitive> {
 
+    static public <T extends OsmPrimitive>  List<T> getFilteredList(Collection<OsmPrimitive> list, Class<T> type) {
+        if (list == null) return null;
+        List<T> ret = new LinkedList<T>();
+        for(OsmPrimitive p: list) {
+            if (type.isInstance(p)) {
+                ret.add(type.cast(p));
+            }
+        }
+        return ret;
+    }
+
+    static public <T extends OsmPrimitive>  Set<T> getFilteredSet(Collection<OsmPrimitive> set, Class<T> type) {
+        if (set == null) return null;
+        HashSet<T> ret = new HashSet<T>();
+        for(OsmPrimitive p: set) {
+            if (type.isInstance(p)) {
+                ret.add(type.cast(p));
+            }
+        }
+        return ret;
+    }
+
+
     /* mappaint data */
     public ElemStyle mappaintStyle = null;
@@ -70 +97 @@
      * the respective class.
      * 
-     * @deprecated use {@see #getId()}. Don't assign an id, create a primitive with
+     * @deprecated use {@see #getId()} and {@see #setId()}. Don't assign an id, create a primitive with
      * the respective constructors.
      */
@@ -120 +147 @@
 
     /**
+     * If set to true, this object is incomplete, which means only the id
+     * and type is known (type is the objects instance class)
+     */
+    public boolean incomplete = false;
+
+    /**
+     * Contains the version number as returned by the API. Needed to
+     * ensure update consistency
+     * @deprecated use {@see #getVersion()} and {@see #setVersion(long)}
+     */
+    @Deprecated
+    public int version = 0;
+
+
+    /**
+     * Creates a new primitive with id 0.
+     * 
+     */
+    public OsmPrimitive() {
+        this(0);
+    }
+
+    /**
+     * Creates a new primitive for the given id. If the id > 0, the primitive is marked
+     * as incomplete.
+     * 
+     * @param id the id. > 0 required
+     * @throws IllegalArgumentException thrown if id < 0
+     */
+    public OsmPrimitive(long id) throws IllegalArgumentException {
+        if (id < 0)
+            throw new IllegalArgumentException(tr("expected id >= 0. Got {0}", id));
+        this.id = id;
+        this.version = 0;
+        this.incomplete = id >0;
+    }
+
+    /* ------------------------------------------------------------------------------------ */
+    /* accessors                                                                            */
+    /* ------------------------------------------------------------------------------------ */
+
+    /**
      * Sets whether this primitive is selected or not.
      * 
@@ -162 +231 @@
      *
      * @return <code>true</code>, if the object has been deleted.
-     * @see #delete(boolean)
+     * @see #setDeleted(boolean)
      */
     public boolean isDeleted() {
@@ -205 +274 @@
 
     /**
+     * Replies the version number as returned by the API. The version is 0 if the id is 0 or
+     * if this primitive is incomplete.
+     * 
+     * @see #setVersion(int)
+     */
+    public long getVersion() {
+        return version;
+    }
+
+    /**
      * Replies the id of this primitive.
      * 
@@ -214 +293 @@
 
     /**
-     * If set to true, this object is highlighted. Currently this is only used to
-     * show which ways/nodes will connect
-     */
-    public volatile boolean highlighted = false;
-
-    private int timestamp;
+     * Sets the id and the version of this primitive if it is known to the OSM API.
+     * 
+     * Since we know the id and its version it can't be incomplete anymore. incomplete
+     * is set to false.
+     * 
+     * @param id the id. > 0 required
+     * @param version the version > 0 required
+     * @throws IllegalArgumentException thrown if id <= 0
+     * @throws IllegalArgumentException thrown if version <= 0
+     */
+    public void setOsmId(long id, int version) {
+        if (id <= 0)
+            throw new IllegalArgumentException(tr("id > 0 expected. Got {0}", id));
+        if (version <= 0)
+            throw new IllegalArgumentException(tr("version > 0 expected. Got {0}", version));
+        this.id = id;
+        this.version = version;
+        this.incomplete = false;
+    }
+
+    /**
+     * Clears the id and version known to the OSM API. The id and the version is set to 0.
+     * incomplete is set to false.
+     * 
+     * <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>
+     * 
+     */
+    public void clearOsmId() {
+        this.id = 0;
+        this.version = 0;
+        this.incomplete = false;
+    }
 
     public void setTimestamp(Date timestamp) {
@@ -240 +356 @@
 
     /**
-     * If set to true, this object is incomplete, which means only the id
-     * and type is known (type is the objects instance class)
-     */
-    public boolean incomplete = false;
-
-    /**
-     * Contains the version number as returned by the API. Needed to
-     * ensure update consistency
-     */
-    public int version = -1;
+     * If set to true, this object is highlighted. Currently this is only used to
+     * show which ways/nodes will connect
+     */
+    public volatile boolean highlighted = false;
+
+    private int timestamp;
 
     private static Collection<String> uninteresting = null;
@@ -288 +400 @@
     abstract public void visit(Visitor visitor);
 
-    public final void delete(boolean deleted) {
+    /**
+     * Sets whether this primitive is deleted or not.
+     * 
+     * Also marks this primitive as modified if deleted is true and sets selected to false.
+     * 
+     * @param deleted  true, if this primitive is deleted; false, otherwise
+     */
+    public void setDeleted(boolean deleted) {
+        this.modified = deleted;
         this.deleted = deleted;
-        setSelected(false);
-        modified = true;
+        this.selected = false;
     }