]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.diagram/src/org/simantics/diagram/symbolcontribution/BasicSymbolProviderFactory.java
Sort symbol item contributions alphanumerically, not lexicographically
[simantics/platform.git] / bundles / org.simantics.diagram / src / org / simantics / diagram / symbolcontribution / BasicSymbolProviderFactory.java
index 41b1953a4472ecd658b3ecc6c68a2a3560e8a2f8..ac934cc7ee2b7ed6b26b8bb45560d0ba71c44d12 100644 (file)
-/*******************************************************************************\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
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+package org.simantics.diagram.symbolcontribution;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Comparator;
+
+import org.simantics.databoard.Bindings;
+import org.simantics.db.ReadGraph;
+import org.simantics.db.Resource;
+import org.simantics.db.common.request.BinaryRead;
+import org.simantics.db.common.request.ObjectsWithSupertype;
+import org.simantics.db.common.utils.NameUtils;
+import org.simantics.db.exception.DatabaseException;
+import org.simantics.diagram.stubs.DiagramResource;
+import org.simantics.diagram.symbollibrary.ISymbolGroup;
+import org.simantics.diagram.symbollibrary.ISymbolItem;
+import org.simantics.layer0.Layer0;
+import org.simantics.utils.strings.AlphanumComparator;
+
+/**
+ * A basic SymbolProviderFactory implementation for the graph database. It is
+ * capable of loading an ISymbolProvider from BasicSymbolContribution instances
+ * like the following:
+ * 
+ * <pre>
+ * _ : DIA.BasicSymbolContribution
+ *     DIA.BasicSymbolContributionHasSymbolLibrary
+ *         MySymbolLibrary1
+ *         MySymbolLibrary2
+ * </pre>
+ * 
+ * @author Tuukka Lehtonen
+ */
+public class BasicSymbolProviderFactory implements SymbolProviderFactory {
+               
+    Resource contribution;
+    Resource diagram;
+
+    public BasicSymbolProviderFactory(Resource contribution, Resource diagram) {
+        this.contribution = contribution;
+        this.diagram = diagram;
+    }
+
+       @Override
+       public int hashCode() {
+               final int prime = 31;
+               int result = 1;
+               result = prime * result + ((contribution == null) ? 0 : contribution.hashCode());
+               result = prime * result + ((diagram == null) ? 0 : diagram.hashCode());
+               return result;
+       }
+
+       @Override
+       public boolean equals(Object obj) {
+               if (this == obj)
+                       return true;
+               if (obj == null)
+                       return false;
+               if (getClass() != obj.getClass())
+                       return false;
+               BasicSymbolProviderFactory other = (BasicSymbolProviderFactory) obj;
+               if (contribution == null) {
+                       if (other.contribution != null)
+                               return false;
+               } else if (!contribution.equals(other.contribution))
+                       return false;
+               if (diagram == null) {
+                       if (other.diagram != null)
+                               return false;
+               } else if (!diagram.equals(other.diagram))
+                       return false;
+               return true;
+       }
+    
+    @Override
+    public ISymbolProvider create(ReadGraph g) throws DatabaseException {
+        return g.syncRequest(new LoadRequest(contribution, diagram));
+    }
+
+    /*
+     * Note: this cannot be ResourceRead since it must never be
+     * classified as immutable because of possible dynamic filters
+     */
+    static class LoadRequest extends BinaryRead<Resource, Resource, ISymbolProvider> {
+        public LoadRequest(Resource contribution, Resource diagram) {
+            super(contribution, diagram);
+        }
+        @Override
+        public ISymbolProvider perform(ReadGraph graph) throws DatabaseException {
+            Layer0 l0 = Layer0.getInstance(graph);
+            DiagramResource dr = DiagramResource.getInstance(graph);
+
+            if (!SymbolProviderFactories.accept(graph, dr, parameter, parameter2))
+                return new SymbolProvider(Collections.<ISymbolGroup>emptyList());
+
+            Collection<Resource> libraries = graph.getObjects(parameter, dr.BasicSymbolContributionHasSymbolLibrary);
+            Collection<ISymbolGroup> groups = new ArrayList<ISymbolGroup>(libraries.size());
+
+            for (Resource library : libraries) {
+                if (SymbolProviderFactories.accept(graph, dr, library, parameter2)) {
+                    groups.add(createGroup(graph, library, l0.DependsOn, parameter2));
+                }
+            }
+
+            return new SymbolProvider(groups);
+            
+        }
+    }
+
+    static class SymbolProvider extends AbstractSymbolProvider {
+        public SymbolProvider(Collection<ISymbolGroup> groups) {
+            super();
+            setSymbolGroup(groups);
+            lockGroups();
+        }
+    }
+
+    static SymbolGroup createGroup(ReadGraph graph, Resource library, Resource relation, Resource diagram) throws DatabaseException {
+        Layer0 l0 = Layer0.getInstance(graph);
+        DiagramResource dr = DiagramResource.getInstance(graph);
+
+        String name = safeName(graph, library);
+        String description = graph.getPossibleRelatedValue2(library, l0.HasDescription, Bindings.STRING);
+        if (description == null)
+            description = name;
+        ModifiableSymbolGroup group = new ModifiableSymbolGroup(library, name, description);
+
+        ArrayList<ISymbolItem> items = new ArrayList<ISymbolItem>();
+        for (Resource item : graph.syncRequest(new ObjectsWithSupertype(library, relation, dr.Element))) {
+            if (!SymbolProviderFactories.accept(graph, dr, item, diagram)) {
+                continue;
+            }
+
+            String itemName = safeName(graph, item);
+            String itemDescription = graph.getPossibleRelatedValue2(item, l0.HasDescription, Bindings.STRING);
+            if (itemDescription == null || itemDescription.isEmpty())
+                itemDescription = itemName;
+            items.add( new ElementSymbolItem(item, itemName, itemDescription, group) );
+        }
+
+        Collections.sort(items, new Comparator<ISymbolItem>() {
+            @Override
+            public int compare(ISymbolItem o1, ISymbolItem o2) {
+                return AlphanumComparator.CASE_INSENSITIVE_COMPARATOR.compare(o1.getName(), o2.getName());
+            }
+        });
+
+        group.setItems(items.toArray(new ISymbolItem[items.size()]));
+
+        return group;
+    }
+
+    private static String safeName(ReadGraph graph, Resource r) throws DatabaseException {
+        Layer0 L0 = Layer0.getInstance(graph);
+        String name = graph.getPossibleRelatedValue2(r, L0.HasLabel, Bindings.STRING);
+        if (name == null || name.isEmpty())
+            name = graph.getPossibleRelatedValue(r, L0.HasName, Bindings.STRING);
+        if (name == null)
+            name = NameUtils.getSafeName(graph, r);
+        return name;
+    }
+
+}