]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.modeling/src/org/simantics/modeling/adapters/ElementRemover.java
Migrated source code from Simantics SVN
[simantics/platform.git] / bundles / org.simantics.modeling / src / org / simantics / modeling / adapters / ElementRemover.java
diff --git a/bundles/org.simantics.modeling/src/org/simantics/modeling/adapters/ElementRemover.java b/bundles/org.simantics.modeling/src/org/simantics/modeling/adapters/ElementRemover.java
new file mode 100644 (file)
index 0000000..2699071
--- /dev/null
@@ -0,0 +1,196 @@
+/*******************************************************************************\r
+ * Copyright (c) 2012 Association for Decentralized Information Management in\r
+ * Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.modeling.adapters;\r
+\r
+import gnu.trove.set.hash.THashSet;\r
+\r
+import java.util.ArrayList;\r
+import java.util.Collection;\r
+import java.util.Set;\r
+\r
+import org.simantics.db.Resource;\r
+import org.simantics.db.WriteGraph;\r
+import org.simantics.db.common.utils.OrderedSetUtils;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.db.layer0.adapter.Remover;\r
+import org.simantics.db.layer0.adapter.impl.AbstractRemover;\r
+import org.simantics.db.layer0.adapter.impl.EntityRemover;\r
+import org.simantics.db.layer0.util.RemoverUtil;\r
+import org.simantics.diagram.content.ConnectionUtil;\r
+import org.simantics.diagram.stubs.DiagramResource;\r
+import org.simantics.layer0.utils.binaryPredicates.OrderedSetElementsPredicate;\r
+import org.simantics.modeling.ModelingResources;\r
+import org.simantics.structural.stubs.StructuralResource2;\r
+\r
+/**\r
+ * A {@link Remover} implementation for removing DIA.Element instances.\r
+ * \r
+ * The implementation has separate paths for STR.Connection instances and other\r
+ * DIA.Element instances. For DIA.Element this remover will:\r
+ * <ol>\r
+ * <li>List connections/monitors the element is attached to</li>\r
+ * <li>Disconnect the element from its owner diagram(s)</li>\r
+ * <li>Remove the element itself with EntityRemover default logic</li>\r
+ * <li>Recursively remove all related degenerate connections, i.e. connections\r
+ * that only have one connector after remove the one connected to this removed\r
+ * element.</li>\r
+ * <li>Recursively remove monitors attached to the removed element</li>\r
+ * </ol>\r
+ * \r
+ * <p>\r
+ * For STR.Connections this remover will:\r
+ * <ol>\r
+ * <li>List all related data (monitors, mapped data)</li> \r
+ * <li>Remove the connection itself</li>\r
+ * <li>Remove the related data</li>\r
+ * </ol>\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public class ElementRemover extends AbstractRemover {\r
+\r
+    private static final boolean DEBUG = false;\r
+\r
+    public ElementRemover(Resource element) {\r
+        super(element);\r
+    }\r
+\r
+    @Override\r
+    public void remove(WriteGraph graph) throws DatabaseException {\r
+        // 0. Find all connections to the removed element\r
+        StructuralResource2 STR = StructuralResource2.getInstance(graph);\r
+\r
+        if (graph.isInstanceOf(resource, STR.Connection)) {\r
+            removeConnection(graph);\r
+        } else {\r
+            removeElement(graph);\r
+        }\r
+    }\r
+\r
+    public void removeElement(WriteGraph graph) throws DatabaseException {\r
+        if (DEBUG)\r
+            System.out.println(this + " removing element");\r
+\r
+        Set<Resource> connectors = null;\r
+\r
+        StructuralResource2 STR = StructuralResource2.getInstance(graph);\r
+        DiagramResource DIA = DiagramResource.getInstance(graph);\r
+\r
+        Collection<Resource> connectedTo = graph.getObjects(resource, STR.IsConnectedTo);\r
+        for (Resource connector : connectedTo) {\r
+            if (connectors == null)\r
+                connectors = new THashSet<Resource>(connectedTo.size());\r
+            connectors.add(connector);\r
+        }\r
+        Collection<Resource> monitors = graph.getObjects(resource, DIA.HasMonitorComponent_Inverse);\r
+\r
+        if (DEBUG) {\r
+            if (connectors != null)\r
+                System.out.println(this + " found " + connectors.size() + " connectors connected to element");\r
+            if (!monitors.isEmpty())\r
+                System.out.println(this + " found " + monitors.size() + " monitors attached to element");\r
+        }\r
+\r
+        // 1. Disconnect element from diagrams\r
+        for (Resource diagram : OrderedSetElementsPredicate.INSTANCE.getSubjects(graph, resource)) {\r
+            OrderedSetUtils.remove(graph, diagram, resource);\r
+        }\r
+\r
+        // 2. Delete element itself\r
+        EntityRemover.remove(graph, resource);\r
+\r
+        // 3. Recursively remove all related degenerate connections\r
+        // i.e. connections that only have one connector after remove the\r
+        // one connected to this removed element.\r
+        ConnectionUtil cu = null;\r
+        Set<Resource> connectionsToRemove = null;\r
+        if (connectors != null) {\r
+            cu = new ConnectionUtil(graph);\r
+            Set<Resource> touchedConnections = new THashSet<Resource>(connectors.size());\r
+            for (Resource connector : connectors) {\r
+                Resource connection = ConnectionUtil.tryGetConnection(graph, connector);\r
+                if (connection != null)\r
+                    touchedConnections.add(connection);\r
+                cu.removeConnectionPart(connector);\r
+            }\r
+            for (Resource connection : touchedConnections) {\r
+                int removedConnectors = cu.removeUnusedConnectors(connection);\r
+                if (DEBUG)\r
+                    System.out.println(this + " PRUNED " + removedConnectors + " UNUSED CONNECTORS FROM TOUCHED CONNECTION " + connection);\r
+                while (true) {\r
+                    int removedInteriorRouteNodes = cu.removeExtraInteriorRouteNodes(connection);\r
+                    if (DEBUG)\r
+                        System.out.println(this + " PRUNED " + removedInteriorRouteNodes + " INTERIOR ROUTE NODES FROM TOUCHED CONNECTION " + connection);\r
+                    if (removedInteriorRouteNodes == 0)\r
+                        break;\r
+                }\r
+                int connectorCount = cu.getConnectedConnectors(connection, null).size();\r
+                if (DEBUG)\r
+                    System.out.println(this + " \t" + connectorCount + " CONNECTORS LEFT");\r
+                if (connectorCount < 2) {\r
+                    if (connectionsToRemove == null)\r
+                        connectionsToRemove = new THashSet<Resource>(touchedConnections.size());\r
+                    connectionsToRemove.add(connection);\r
+                }\r
+            }\r
+        }\r
+        if (connectionsToRemove != null) {\r
+            for (Resource connection : connectionsToRemove) {\r
+                if (DEBUG)\r
+                    System.out.println(this + " REMOVING connection " + connection);\r
+                RemoverUtil.remove(graph, connection);\r
+            }\r
+        }\r
+\r
+        // 4. Recursively remove monitors attached to element\r
+        if (!monitors.isEmpty())\r
+            for (Resource monitor : monitors)\r
+                RemoverUtil.remove(graph, monitor);\r
+\r
+    }\r
+\r
+    public void removeConnection(WriteGraph graph) throws DatabaseException {\r
+        if (DEBUG)\r
+            System.out.println(this + " removing connection element");\r
+\r
+        DiagramResource DIA = DiagramResource.getInstance(graph);\r
+        ModelingResources MOD = ModelingResources.getInstance(graph);\r
+\r
+        // 0. Get set of related data\r
+        Collection<Resource> objects = new ArrayList<Resource>();\r
+        for (Resource relation : new Resource[] {\r
+                DIA.HasMonitorComponent_Inverse,\r
+                MOD.ElementToComponent,\r
+                MOD.DiagramConnectionToConnection,\r
+                MOD.DiagramConnectionToConnectionSpecial\r
+        }) {\r
+            for (Resource object : graph.getObjects(resource, relation)) {\r
+                if (!object.equals(resource))\r
+                    objects.add(object);\r
+            }\r
+        }\r
+\r
+        // 1. Remove connection itself\r
+        new ConnectionUtil(graph).removeConnection(resource);\r
+\r
+        // 2. Recursively remove related data\r
+        if (!objects.isEmpty())\r
+            for (Resource object : objects)\r
+                RemoverUtil.remove(graph, object);\r
+    }\r
+\r
+    @Override\r
+    public String toString() {\r
+        return getClass().getSimpleName() + resource;\r
+    }\r
+\r
+}\r