Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.diagram / src / org / simantics / diagram / symbolcontribution / BasicSymbolProviderFactory.java

diff --git a/bundles/org.simantics.diagram/src/org/simantics/diagram/symbolcontribution/BasicSymbolProviderFactory.java b/bundles/org.simantics.diagram/src/org/simantics/diagram/symbolcontribution/BasicSymbolProviderFactory.java
new file mode 100644 (file)
index 0000000..41b1953
--- /dev/null
+++ b/bundles/org.simantics.diagram/src/org/simantics/diagram/symbolcontribution/BasicSymbolProviderFactory.java
@@ -0,0 +1,174 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in 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.diagram.symbolcontribution;\r
+\r
+import java.util.ArrayList;\r
+import java.util.Collection;\r
+import java.util.Collections;\r
+import java.util.Comparator;\r
+\r
+import org.simantics.databoard.Bindings;\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.Resource;\r
+import org.simantics.db.common.request.BinaryRead;\r
+import org.simantics.db.common.request.ObjectsWithSupertype;\r
+import org.simantics.db.common.utils.NameUtils;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.diagram.stubs.DiagramResource;\r
+import org.simantics.diagram.symbollibrary.ISymbolGroup;\r
+import org.simantics.diagram.symbollibrary.ISymbolItem;\r
+import org.simantics.layer0.Layer0;\r
+\r
+/**\r
+ * A basic SymbolProviderFactory implementation for the graph database. It is\r
+ * capable of loading an ISymbolProvider from BasicSymbolContribution instances\r
+ * like the following:\r
+ * \r
+ * <pre>\r
+ * _ : DIA.BasicSymbolContribution\r
+ *     DIA.BasicSymbolContributionHasSymbolLibrary\r
+ *         MySymbolLibrary1\r
+ *         MySymbolLibrary2\r
+ * </pre>\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public class BasicSymbolProviderFactory implements SymbolProviderFactory {\r
+               \r
+    Resource contribution;\r
+    Resource diagram;\r
+\r
+    public BasicSymbolProviderFactory(Resource contribution, Resource diagram) {\r
+        this.contribution = contribution;\r
+        this.diagram = diagram;\r
+    }\r
+\r
+       @Override\r
+       public int hashCode() {\r
+               final int prime = 31;\r
+               int result = 1;\r
+               result = prime * result + ((contribution == null) ? 0 : contribution.hashCode());\r
+               result = prime * result + ((diagram == null) ? 0 : diagram.hashCode());\r
+               return result;\r
+       }\r
+\r
+       @Override\r
+       public boolean equals(Object obj) {\r
+               if (this == obj)\r
+                       return true;\r
+               if (obj == null)\r
+                       return false;\r
+               if (getClass() != obj.getClass())\r
+                       return false;\r
+               BasicSymbolProviderFactory other = (BasicSymbolProviderFactory) obj;\r
+               if (contribution == null) {\r
+                       if (other.contribution != null)\r
+                               return false;\r
+               } else if (!contribution.equals(other.contribution))\r
+                       return false;\r
+               if (diagram == null) {\r
+                       if (other.diagram != null)\r
+                               return false;\r
+               } else if (!diagram.equals(other.diagram))\r
+                       return false;\r
+               return true;\r
+       }\r
+    \r
+    @Override\r
+    public ISymbolProvider create(ReadGraph g) throws DatabaseException {\r
+        return g.syncRequest(new LoadRequest(contribution, diagram));\r
+    }\r
+\r
+    /*\r
+     * Note: this cannot be ResourceRead since it must never be\r
+     * classified as immutable because of possible dynamic filters\r
+     */\r
+    static class LoadRequest extends BinaryRead<Resource, Resource, ISymbolProvider> {\r
+        public LoadRequest(Resource contribution, Resource diagram) {\r
+            super(contribution, diagram);\r
+        }\r
+        @Override\r
+        public ISymbolProvider perform(ReadGraph graph) throws DatabaseException {\r
+            Layer0 l0 = Layer0.getInstance(graph);\r
+            DiagramResource dr = DiagramResource.getInstance(graph);\r
+\r
+            if (!SymbolProviderFactories.accept(graph, dr, parameter, parameter2))\r
+                return new SymbolProvider(Collections.<ISymbolGroup>emptyList());\r
+\r
+            Collection<Resource> libraries = graph.getObjects(parameter, dr.BasicSymbolContributionHasSymbolLibrary);\r
+            Collection<ISymbolGroup> groups = new ArrayList<ISymbolGroup>(libraries.size());\r
+\r
+            for (Resource library : libraries) {\r
+                if (SymbolProviderFactories.accept(graph, dr, library, parameter2)) {\r
+                    groups.add(createGroup(graph, library, l0.DependsOn, parameter2));\r
+                }\r
+            }\r
+\r
+            return new SymbolProvider(groups);\r
+            \r
+        }\r
+    }\r
+\r
+    static class SymbolProvider extends AbstractSymbolProvider {\r
+        public SymbolProvider(Collection<ISymbolGroup> groups) {\r
+            super();\r
+            setSymbolGroup(groups);\r
+            lockGroups();\r
+        }\r
+    }\r
+\r
+    static SymbolGroup createGroup(ReadGraph graph, Resource library, Resource relation, Resource diagram) throws DatabaseException {\r
+        Layer0 l0 = Layer0.getInstance(graph);\r
+        DiagramResource dr = DiagramResource.getInstance(graph);\r
+\r
+        String name = safeName(graph, library);\r
+        String description = graph.getPossibleRelatedValue2(library, l0.HasDescription, Bindings.STRING);\r
+        if (description == null)\r
+            description = name;\r
+        ModifiableSymbolGroup group = new ModifiableSymbolGroup(library, name, description);\r
+\r
+        ArrayList<ISymbolItem> items = new ArrayList<ISymbolItem>();\r
+        for (Resource item : graph.syncRequest(new ObjectsWithSupertype(library, relation, dr.Element))) {\r
+            if (!SymbolProviderFactories.accept(graph, dr, item, diagram)) {\r
+                continue;\r
+            }\r
+\r
+            String itemName = safeName(graph, item);\r
+            String itemDescription = graph.getPossibleRelatedValue2(item, l0.HasDescription, Bindings.STRING);\r
+            if (itemDescription == null || itemDescription.isEmpty())\r
+                itemDescription = itemName;\r
+            items.add( new ElementSymbolItem(item, itemName, itemDescription, group) );\r
+        }\r
+\r
+        Collections.sort(items, new Comparator<ISymbolItem>() {\r
+            @Override\r
+            public int compare(ISymbolItem o1, ISymbolItem o2) {\r
+                return o1.getName().compareToIgnoreCase(o2.getName());\r
+            }\r
+        });\r
+\r
+        group.setItems(items.toArray(new ISymbolItem[items.size()]));\r
+\r
+        return group;\r
+    }\r
+\r
+    private static String safeName(ReadGraph graph, Resource r) throws DatabaseException {\r
+        Layer0 L0 = Layer0.getInstance(graph);\r
+        String name = graph.getPossibleRelatedValue2(r, L0.HasLabel, Bindings.STRING);\r
+        if (name == null || name.isEmpty())\r
+            name = graph.getPossibleRelatedValue(r, L0.HasName, Bindings.STRING);\r
+        if (name == null)\r
+            name = NameUtils.getSafeName(graph, r);\r
+        return name;\r
+    }\r
+\r
+}\r