Changeset 3348 in josm for trunk/src/org/openstreetmap/josm/data/osm/DataSet.java

Timestamp:

2010-06-27T17:07:49+02:00 (14 years ago)

Author:

jttt

Message:

Thread safe Dataset and OsmPrimitive, read/write lock for dataset

File:

• trunk/src/org/openstreetmap/josm/data/osm/DataSet.java (modified) (14 diffs)

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

@@ -15 +15 @@
 import java.util.List;
 import java.util.Map;
+import java.util.concurrent.locks.Lock;
+import java.util.concurrent.locks.ReadWriteLock;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
 
 import org.openstreetmap.josm.data.SelectionChangedListener;
@@ -42 +45 @@
 public class DataSet implements Cloneable {
 
+    /**
+     * Maximum number of events that can be fired between beginUpdate/endUpdate to be send as single events (ie without DatasetChangedEvent)
+     */
+    private static final int MAX_SINGLE_EVENTS = 30;
+
+    /**
+     * Maximum number of events to kept between beginUpdate/endUpdate. When more events are created, that simple DatasetChangedEvent is sent)
+     */
+    private static final int MAX_EVENTS = 1000;
+
     private static class IdHash implements Hash<PrimitiveId,OsmPrimitive> {
 
@@ -57 +70 @@
     private Map<PrimitiveId, OsmPrimitive> primitivesMap = allPrimitives.foreignKey(new IdHash());
     private List<DataSetListener> listeners = new ArrayList<DataSetListener>();
+
     // Number of open calls to beginUpdate
     private int updateCount;
+    // Events that occurred while dataset was locked but should be fired after write lock is released
+    private final List<AbstractDatasetChangedEvent> cachedEvents = new ArrayList<AbstractDatasetChangedEvent>();
 
     private int highlightUpdateCount;
+
+    private final ReadWriteLock lock = new ReentrantReadWriteLock();
+
+    public Lock getReadLock() {
+        return lock.readLock();
+    }
 
     /**
@@ -212 +234 @@
      */
     public void addPrimitive(OsmPrimitive primitive) {
-        if (getPrimitiveById(primitive) != null)
-            throw new DataIntegrityProblemException(
-                    tr("Unable to add primitive {0} to the dataset because it is already included", primitive.toString()));
-
-        primitive.updatePosition(); // Set cached bbox for way and relation (required for reindexWay and reinexRelation to work properly)
-        if (primitive instanceof Node) {
-            nodes.add((Node) primitive);
-        } else if (primitive instanceof Way) {
-            ways.add((Way) primitive);
-        } else if (primitive instanceof Relation) {
-            relations.add((Relation) primitive);
-        }
-        allPrimitives.add(primitive);
-        primitive.setDataset(this);
-        firePrimitivesAdded(Collections.singletonList(primitive), false);
+        beginUpdate();
+        try {
+            if (getPrimitiveById(primitive) != null)
+                throw new DataIntegrityProblemException(
+                        tr("Unable to add primitive {0} to the dataset because it is already included", primitive.toString()));
+
+            primitive.updatePosition(); // Set cached bbox for way and relation (required for reindexWay and reinexRelation to work properly)
+            if (primitive instanceof Node) {
+                nodes.add((Node) primitive);
+            } else if (primitive instanceof Way) {
+                ways.add((Way) primitive);
+            } else if (primitive instanceof Relation) {
+                relations.add((Relation) primitive);
+            }
+            allPrimitives.add(primitive);
+            primitive.setDataset(this);
+            firePrimitivesAdded(Collections.singletonList(primitive), false);
+        } finally {
+            endUpdate();
+        }
     }
 
     public OsmPrimitive addPrimitive(PrimitiveData data) {
-        OsmPrimitive result;
-        if (data instanceof NodeData) {
-            result = new Node();
-        } else if (data instanceof WayData) {
-            result = new Way();
-        } else if (data instanceof RelationData) {
-            result = new Relation();
-        } else
-            throw new AssertionError();
-        result.setDataset(this);
-        result.load(data);
-        addPrimitive(result);
-        return result;
+        beginUpdate();
+        try {
+            OsmPrimitive result;
+            if (data instanceof NodeData) {
+                result = new Node();
+            } else if (data instanceof WayData) {
+                result = new Way();
+            } else if (data instanceof RelationData) {
+                result = new Relation();
+            } else
+                throw new AssertionError();
+            result.setDataset(this);
+            result.load(data);
+            addPrimitive(result);
+            return result;
+        } finally {
+            endUpdate();
+        }
     }
 
@@ -255 +287 @@
      */
     public void removePrimitive(PrimitiveId primitiveId) {
-        OsmPrimitive primitive = getPrimitiveByIdChecked(primitiveId);
-        if (primitive == null)
-            return;
-        if (primitive instanceof Node) {
-            nodes.remove(primitive);
-        } else if (primitive instanceof Way) {
-            ways.remove(primitive);
-        } else if (primitive instanceof Relation) {
-            relations.remove(primitive);
-        }
-        selectedPrimitives.remove(primitive);
-        allPrimitives.remove(primitive);
-        primitive.setDataset(null);
-        firePrimitivesRemoved(Collections.singletonList(primitive), false);
+        beginUpdate();
+        try {
+            OsmPrimitive primitive = getPrimitiveByIdChecked(primitiveId);
+            if (primitive == null)
+                return;
+            if (primitive instanceof Node) {
+                nodes.remove(primitive);
+            } else if (primitive instanceof Way) {
+                ways.remove(primitive);
+            } else if (primitive instanceof Relation) {
+                relations.remove(primitive);
+            }
+            selectedPrimitives.remove(primitive);
+            allPrimitives.remove(primitive);
+            primitive.setDataset(null);
+            firePrimitivesRemoved(Collections.singletonList(primitive), false);
+        } finally {
+            endUpdate();
+        }
     }
 
@@ -492 +529 @@
      */
 
-//    public void setDisabled(OsmPrimitive... osm) {
-//        if (osm.length == 1 && osm[0] == null) {
-//            setDisabled();
-//            return;
-//        }
-//        clearDisabled(allPrimitives());
-//        for (OsmPrimitive o : osm)
-//            if (o != null) {
-//                o.setDisabled(true);
-//            }
-//    }
-//
-//    public void setDisabled(Collection<? extends OsmPrimitive> selection) {
-//        clearDisabled(nodes);
-//        clearDisabled(ways);
-//        clearDisabled(relations);
-//        for (OsmPrimitive osm : selection) {
-//            osm.setDisabled(true);
-//        }
-//    }
-//
-//    /**
-//     * Remove the disabled parameter from every value in the collection.
-//     * @param list The collection to remove the disabled parameter from.
-//     */
-//    private void clearDisabled(Collection<? extends OsmPrimitive> list) {
-//        for (OsmPrimitive osm : list) {
-//            osm.setDisabled(false);
-//        }
-//    }
-//
-//
-//    public void setFiltered(Collection<? extends OsmPrimitive> selection) {
-//        clearFiltered(nodes);
-//        clearFiltered(ways);
-//        clearFiltered(relations);
-//        for (OsmPrimitive osm : selection) {
-//            osm.setFiltered(true);
-//        }
-//    }
-//
-//    public void setFiltered(OsmPrimitive... osm) {
-//        if (osm.length == 1 && osm[0] == null) {
-//            setFiltered();
-//            return;
-//        }
-//        clearFiltered(nodes);
-//        clearFiltered(ways);
-//        clearFiltered(relations);
-//        for (OsmPrimitive o : osm)
-//            if (o != null) {
-//                o.setFiltered(true);
-//            }
-//    }
-//
-//    /**
-//     * Remove the filtered parameter from every value in the collection.
-//     * @param list The collection to remove the filtered parameter from.
-//     */
-//    private void clearFiltered(Collection<? extends OsmPrimitive> list) {
-//        if (list == null)
-//            return;
-//        for (OsmPrimitive osm : list) {
-//            osm.setFiltered(false);
-//        }
-//    }
+    //    public void setDisabled(OsmPrimitive... osm) {
+    //        if (osm.length == 1 && osm[0] == null) {
+    //            setDisabled();
+    //            return;
+    //        }
+    //        clearDisabled(allPrimitives());
+    //        for (OsmPrimitive o : osm)
+    //            if (o != null) {
+    //                o.setDisabled(true);
+    //            }
+    //    }
+    //
+    //    public void setDisabled(Collection<? extends OsmPrimitive> selection) {
+    //        clearDisabled(nodes);
+    //        clearDisabled(ways);
+    //        clearDisabled(relations);
+    //        for (OsmPrimitive osm : selection) {
+    //            osm.setDisabled(true);
+    //        }
+    //    }
+    //
+    //    /**
+    //     * Remove the disabled parameter from every value in the collection.
+    //     * @param list The collection to remove the disabled parameter from.
+    //     */
+    //    private void clearDisabled(Collection<? extends OsmPrimitive> list) {
+    //        for (OsmPrimitive osm : list) {
+    //            osm.setDisabled(false);
+    //        }
+    //    }
+    //
+    //
+    //    public void setFiltered(Collection<? extends OsmPrimitive> selection) {
+    //        clearFiltered(nodes);
+    //        clearFiltered(ways);
+    //        clearFiltered(relations);
+    //        for (OsmPrimitive osm : selection) {
+    //            osm.setFiltered(true);
+    //        }
+    //    }
+    //
+    //    public void setFiltered(OsmPrimitive... osm) {
+    //        if (osm.length == 1 && osm[0] == null) {
+    //            setFiltered();
+    //            return;
+    //        }
+    //        clearFiltered(nodes);
+    //        clearFiltered(ways);
+    //        clearFiltered(relations);
+    //        for (OsmPrimitive o : osm)
+    //            if (o != null) {
+    //                o.setFiltered(true);
+    //            }
+    //    }
+    //
+    //    /**
+    //     * Remove the filtered parameter from every value in the collection.
+    //     * @param list The collection to remove the filtered parameter from.
+    //     */
+    //    private void clearFiltered(Collection<? extends OsmPrimitive> list) {
+    //        if (list == null)
+    //            return;
+    //        for (OsmPrimitive osm : list) {
+    //            osm.setFiltered(false);
+    //        }
+    //    }
 
     @Override public DataSet clone() {
-        DataSet ds = new DataSet();
-        HashMap<OsmPrimitive, OsmPrimitive> primitivesMap = new HashMap<OsmPrimitive, OsmPrimitive>();
-        for (Node n : nodes) {
-            Node newNode = new Node(n);
-            primitivesMap.put(n, newNode);
-            ds.addPrimitive(newNode);
-        }
-        for (Way w : ways) {
-            Way newWay = new Way(w);
-            primitivesMap.put(w, newWay);
-            List<Node> newNodes = new ArrayList<Node>();
-            for (Node n: w.getNodes()) {
-                newNodes.add((Node)primitivesMap.get(n));
-            }
-            newWay.setNodes(newNodes);
-            ds.addPrimitive(newWay);
-        }
-        // Because relations can have other relations as members we first clone all relations
-        // and then get the cloned members
-        for (Relation r : relations) {
-            Relation newRelation = new Relation(r, r.isNew());
-            newRelation.setMembers(null);
-            primitivesMap.put(r, newRelation);
-            ds.addPrimitive(newRelation);
-        }
-        for (Relation r : relations) {
-            Relation newRelation = (Relation)primitivesMap.get(r);
-            List<RelationMember> newMembers = new ArrayList<RelationMember>();
-            for (RelationMember rm: r.getMembers()) {
-                newMembers.add(new RelationMember(rm.getRole(), primitivesMap.get(rm.getMember())));
-            }
-            newRelation.setMembers(newMembers);
-        }
-        for (DataSource source : dataSources) {
-            ds.dataSources.add(new DataSource(source.bounds, source.origin));
-        }
-        ds.version = version;
-        return ds;
+        getReadLock().lock();
+        try {
+            DataSet ds = new DataSet();
+            HashMap<OsmPrimitive, OsmPrimitive> primitivesMap = new HashMap<OsmPrimitive, OsmPrimitive>();
+            for (Node n : nodes) {
+                Node newNode = new Node(n);
+                primitivesMap.put(n, newNode);
+                ds.addPrimitive(newNode);
+            }
+            for (Way w : ways) {
+                Way newWay = new Way(w);
+                primitivesMap.put(w, newWay);
+                List<Node> newNodes = new ArrayList<Node>();
+                for (Node n: w.getNodes()) {
+                    newNodes.add((Node)primitivesMap.get(n));
+                }
+                newWay.setNodes(newNodes);
+                ds.addPrimitive(newWay);
+            }
+            // Because relations can have other relations as members we first clone all relations
+            // and then get the cloned members
+            for (Relation r : relations) {
+                Relation newRelation = new Relation(r, r.isNew());
+                newRelation.setMembers(null);
+                primitivesMap.put(r, newRelation);
+                ds.addPrimitive(newRelation);
+            }
+            for (Relation r : relations) {
+                Relation newRelation = (Relation)primitivesMap.get(r);
+                List<RelationMember> newMembers = new ArrayList<RelationMember>();
+                for (RelationMember rm: r.getMembers()) {
+                    newMembers.add(new RelationMember(rm.getRole(), primitivesMap.get(rm.getMember())));
+                }
+                newRelation.setMembers(newMembers);
+            }
+            for (DataSource source : dataSources) {
+                ds.dataSources.add(new DataSource(source.bounds, source.origin));
+            }
+            ds.version = version;
+            return ds;
+        } finally {
+            getReadLock().unlock();
+        }
     }
 
@@ -663 +705 @@
     }
 
-    protected void deleteWay(Way way) {
+    private void deleteWay(Way way) {
         way.setNodes(null);
         way.setDeleted(true);
@@ -674 +716 @@
      */
     public void unlinkNodeFromWays(Node node) {
-        for (Way way: ways) {
-            List<Node> nodes = way.getNodes();
-            if (nodes.remove(node)) {
-                if (nodes.size() < 2) {
-                    deleteWay(way);
-                } else {
-                    way.setNodes(nodes);
+        beginUpdate();
+        try {
+            for (Way way: ways) {
+                List<Node> nodes = way.getNodes();
+                if (nodes.remove(node)) {
+                    if (nodes.size() < 2) {
+                        deleteWay(way);
+                    } else {
+                        way.setNodes(nodes);
+                    }
                 }
             }
+        } finally {
+            endUpdate();
         }
     }
@@ -692 +739 @@
      */
     public void unlinkPrimitiveFromRelations(OsmPrimitive primitive) {
-        for (Relation relation : relations) {
-            List<RelationMember> members = relation.getMembers();
-
-            Iterator<RelationMember> it = members.iterator();
-            boolean removed = false;
-            while(it.hasNext()) {
-                RelationMember member = it.next();
-                if (member.getMember().equals(primitive)) {
-                    it.remove();
-                    removed = true;
+        beginUpdate();
+        try {
+            for (Relation relation : relations) {
+                List<RelationMember> members = relation.getMembers();
+
+                Iterator<RelationMember> it = members.iterator();
+                boolean removed = false;
+                while(it.hasNext()) {
+                    RelationMember member = it.next();
+                    if (member.getMember().equals(primitive)) {
+                        it.remove();
+                        removed = true;
+                    }
                 }
-            }
-
-            if (removed) {
-                relation.setMembers(members);
-            }
+
+                if (removed) {
+                    relation.setMembers(members);
+                }
+            }
+        } finally {
+            endUpdate();
         }
     }
@@ -718 +770 @@
      */
     public void unlinkReferencesToPrimitive(OsmPrimitive referencedPrimitive) {
-        if (referencedPrimitive instanceof Node) {
-            unlinkNodeFromWays((Node)referencedPrimitive);
-            unlinkPrimitiveFromRelations(referencedPrimitive);
-        } else {
-            unlinkPrimitiveFromRelations(referencedPrimitive);
+        beginUpdate();
+        try {
+            if (referencedPrimitive instanceof Node) {
+                unlinkNodeFromWays((Node)referencedPrimitive);
+                unlinkPrimitiveFromRelations(referencedPrimitive);
+            } else {
+                unlinkPrimitiveFromRelations(referencedPrimitive);
+            }
+        } finally {
+            endUpdate();
         }
     }
@@ -804 +861 @@
      */
     public void beginUpdate() {
+        lock.writeLock().lock();
         updateCount++;
     }
@@ -814 +872 @@
             updateCount--;
             if (updateCount == 0) {
-                fireDataChanged();
-            }
+                List<AbstractDatasetChangedEvent> eventsCopy = new ArrayList<AbstractDatasetChangedEvent>(cachedEvents);
+                cachedEvents.clear();
+                lock.writeLock().unlock();
+
+                if (!eventsCopy.isEmpty()) {
+                    lock.readLock().lock();
+                    try {
+                        if (eventsCopy.size() < MAX_SINGLE_EVENTS) {
+                            for (AbstractDatasetChangedEvent event: eventsCopy) {
+                                fireEventToListeners(event);
+                            }
+                        } else if (eventsCopy.size() == MAX_EVENTS) {
+                            fireEventToListeners(new DataChangedEvent(this));
+                        } else {
+                            fireEventToListeners(new DataChangedEvent(this, eventsCopy));
+                        }
+                    } finally {
+                        lock.readLock().unlock();
+                    }
+                }
+            } else {
+                lock.writeLock().unlock();
+            }
+
         } else
             throw new AssertionError("endUpdate called without beginUpdate");
     }
 
+    private void fireEventToListeners(AbstractDatasetChangedEvent event) {
+        for (DataSetListener listener: listeners) {
+            event.fire(listener);
+        }
+    }
+
     private void fireEvent(AbstractDatasetChangedEvent event) {
-        if (updateCount == 0) {
-            for (DataSetListener dsl : listeners) {
-                event.fire(dsl);
-            }
-        }
-    }
-
-    private void fireDataChanged() {
-        fireEvent(new DataChangedEvent(this));
+        if (updateCount == 0)
+            throw new AssertionError("dataset events can be fired only when dataset is locked");
+        if (cachedEvents.size() < MAX_EVENTS) {
+            cachedEvents.add(event);
+        }
     }
 
@@ -868 +950 @@
 
     public void clenupDeletedPrimitives() {
-        if (cleanupDeleted(nodes.iterator())
-                | cleanupDeleted(ways.iterator())
-                | cleanupDeleted(relations.iterator())) {
-            fireSelectionChanged();
+        beginUpdate();
+        try {
+            if (cleanupDeleted(nodes.iterator())
+                    | cleanupDeleted(ways.iterator())
+                    | cleanupDeleted(relations.iterator())) {
+                fireSelectionChanged();
+            }
+        } finally {
+            endUpdate();
         }
     }
@@ -896 +983 @@
      */
     public void clear() {
-        clearSelection();
-        for (OsmPrimitive primitive:allPrimitives) {
-            primitive.setDataset(null);
-        }
-        nodes.clear();
-        ways.clear();
-        relations.clear();
-        allPrimitives.clear();
+        beginUpdate();
+        try {
+            clearSelection();
+            for (OsmPrimitive primitive:allPrimitives) {
+                primitive.setDataset(null);
+            }
+            nodes.clear();
+            ways.clear();
+            relations.clear();
+            allPrimitives.clear();
+        } finally {
+            endUpdate();
+        }
     }
 }