]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/actions/ActionBrowseContext.java
Migrated source code from Simantics SVN
[simantics/platform.git] / bundles / org.simantics.browsing.ui.model / src / org / simantics / browsing / ui / model / actions / ActionBrowseContext.java
diff --git a/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/actions/ActionBrowseContext.java b/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/actions/ActionBrowseContext.java
new file mode 100644 (file)
index 0000000..e1c67be
--- /dev/null
@@ -0,0 +1,214 @@
+/*******************************************************************************\r
+ * Copyright (c) 2010, 2011 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.browsing.ui.model.actions;\r
+\r
+import gnu.trove.map.hash.THashMap;\r
+import gnu.trove.set.hash.THashSet;\r
+\r
+import java.util.ArrayList;\r
+import java.util.Arrays;\r
+import java.util.Collection;\r
+import java.util.Collections;\r
+import java.util.HashSet;\r
+import java.util.List;\r
+import java.util.Map;\r
+import java.util.Set;\r
+\r
+import org.eclipse.jface.action.Action;\r
+import org.simantics.browsing.ui.BuiltinKeys;\r
+import org.simantics.browsing.ui.NodeContext;\r
+import org.simantics.browsing.ui.model.InvalidContribution;\r
+import org.simantics.browsing.ui.model.browsecontexts.BrowseContexts;\r
+import org.simantics.browsing.ui.model.browsecontexts.ResolveActionBrowseContext;\r
+import org.simantics.browsing.ui.model.nodetypes.EntityNodeType;\r
+import org.simantics.browsing.ui.model.nodetypes.NodeType;\r
+import org.simantics.browsing.ui.model.nodetypes.NodeTypeMultiMap;\r
+import org.simantics.browsing.ui.model.nodetypes.SpecialNodeType;\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.Resource;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.viewpoint.ontology.ViewpointResource;\r
+\r
+/**\r
+ * ActionBrowseContext holds all contributions related to given set of action browse contexts.\r
+ * \r
+ * @author Hannu Niemistö\r
+ */\r
+public class ActionBrowseContext {\r
+    NodeTypeMultiMap<ActionContribution> actionContributions = new NodeTypeMultiMap<ActionContribution>();\r
+    // TODO: remove these two temporary mechanisms\r
+    THashSet<Resource> removableNodeTypes = new THashSet<Resource>(); \r
+    THashSet<Resource> renameableNodeTypes = new THashSet<Resource>(); \r
+    NodeTypeMultiMap<TestContribution> removalContributions = new NodeTypeMultiMap<TestContribution>();\r
+    NodeTypeMultiMap<TestContribution> renamingContributions = new NodeTypeMultiMap<TestContribution>();\r
+\r
+    private final String[] uris; \r
+\r
+    private ActionBrowseContext(String[] uris) {\r
+        if (uris == null)\r
+            throw new NullPointerException("null URIs");\r
+        this.uris = uris;\r
+    }\r
+\r
+    public String[] getURIs() {\r
+        return uris;\r
+    }\r
+\r
+    public static ActionBrowseContext get(ReadGraph graph,NodeContext context,ActionBrowseContext defaultContext) throws DatabaseException {\r
+        ActionBrowseContext mbc = graph.syncRequest(new ResolveActionBrowseContext(context));\r
+        if(mbc != null) return mbc;\r
+        ActionBrowseContext parentContext = (ActionBrowseContext)context.getConstant(BuiltinKeys.ACTION_BROWSE_CONTEXT);\r
+        if(parentContext != null) return parentContext;\r
+        return defaultContext;\r
+    }\r
+    \r
+    public static ActionBrowseContext create(ReadGraph g, Collection<Resource> browseContextResources) throws DatabaseException, InvalidContribution {\r
+        ViewpointResource vr = ViewpointResource.getInstance(g);\r
+        ActionBrowseContext browseContext = new ActionBrowseContext( BrowseContexts.toSortedURIs(g, browseContextResources) );\r
+        for(Resource browseContextResource : findSubcontexts(g, browseContextResources)) {\r
+            for(Resource actionContributionResource : \r
+                g.getObjects(browseContextResource, vr.BrowseContext_HasActionContribution)) {\r
+                try {\r
+                    ActionContribution.load(g, actionContributionResource,\r
+                            browseContext.actionContributions\r
+                            );\r
+                } catch(DatabaseException e) {\r
+                    e.printStackTrace();\r
+                }\r
+            }\r
+            for(Resource canRemove : g.getObjects(browseContextResource, vr.BrowseContext_SupportsRemovalOf))\r
+                browseContext.removableNodeTypes.add(canRemove);\r
+            for(Resource canRemove : g.getObjects(browseContextResource, vr.BrowseContext_SupportsRenamingOf))\r
+                browseContext.renameableNodeTypes.add(canRemove);\r
+\r
+            for (Resource testContribution : g.getObjects(browseContextResource, vr.BrowseContext_HasTestContribution)) {\r
+                try {\r
+                    Set<Resource> types = g.getTypes(testContribution);\r
+                    if (types.contains(vr.RemovalTestContribution))\r
+                        TestContribution.load(g, testContribution, browseContext.removalContributions);\r
+                    if (types.contains(vr.RenamingTestContribution))\r
+                        TestContribution.load(g, testContribution, browseContext.renamingContributions);\r
+                } catch (DatabaseException e) {\r
+                    e.printStackTrace();\r
+                }\r
+            }\r
+        }\r
+        return browseContext;\r
+    }\r
+    \r
+    private static Collection<Resource> findSubcontexts(ReadGraph g,\r
+            Collection<Resource> browseContexts) throws DatabaseException {\r
+        ViewpointResource vr = ViewpointResource.getInstance(g);\r
+        HashSet<Resource> result = new HashSet<Resource>(browseContexts);\r
+        ArrayList<Resource> stack = new ArrayList<Resource>(browseContexts);\r
+        while(!stack.isEmpty()) {\r
+            Resource cur = stack.remove(stack.size()-1);\r
+            for(Resource sc : g.getObjects(cur, vr.BrowseContext_Includes))\r
+                if(result.add(sc))\r
+                    stack.add(sc);\r
+        }\r
+        return result;\r
+    }    \r
+    \r
+    private static NodeType getNodeType(ReadGraph graph, NodeContext parent) throws DatabaseException {\r
+        NodeType nodeType = parent.getConstant(NodeType.TYPE);\r
+        if(nodeType == null) {            \r
+            // TODO remove this code when root of model browser is fixed\r
+            Object input = parent.getConstant(BuiltinKeys.INPUT);\r
+            if(input instanceof Resource)\r
+                nodeType = EntityNodeType.getNodeTypeFor(graph, (Resource)input);\r
+        }\r
+        return nodeType;\r
+    }\r
+    \r
+    public Map<IActionCategory, List<Action>> getActions(ReadGraph graph, NodeContext parent, Collection<NodeContext> all) throws DatabaseException {\r
+        NodeType nodeType = getNodeType(graph, parent);\r
+        if(nodeType == null)\r
+            return Collections.emptyMap();\r
+        THashMap<IActionCategory, List<Action>> map = new THashMap<IActionCategory, List<Action>>();\r
+        for(ActionContribution contribution : actionContributions.get(graph, nodeType)) { \r
+            CategorizedAction action = contribution.getAction(graph, parent, all);\r
+            if(action != null) {\r
+                List<Action> actions = map.get(action.category);\r
+                if(actions == null) {\r
+                    actions = new ArrayList<Action>();\r
+                    map.put(action.category, actions);\r
+                }\r
+                actions.add(action.action);\r
+            }\r
+        }\r
+        return map;\r
+    }\r
+\r
+    @Override\r
+    public int hashCode() {\r
+        return Arrays.hashCode(uris);\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
+        ActionBrowseContext other = (ActionBrowseContext) obj;\r
+        return Arrays.equals(uris, other.uris);\r
+    }\r
+\r
+    @Override\r
+    public String toString() {\r
+        return getClass().getSimpleName() + Arrays.toString(uris);\r
+    }\r
+\r
+    /*\r
+     * This is an attempt to improve removal logic with SpecialNodeTypes. However it\r
+     * should not be considered as a final solution.\r
+     */\r
+    public boolean canRemove(ReadGraph graph, NodeContext parent) throws DatabaseException {\r
+        return testContributions(graph, parent, removalContributions, removableNodeTypes);\r
+    }\r
+\r
+    /*\r
+     * This is an attempt to improve renaming logic with SpecialNodeTypes. However it\r
+     * should not be considered as a final solution.\r
+     */\r
+    public boolean canRename(ReadGraph graph, NodeContext parent) throws DatabaseException {\r
+        return testContributions(graph, parent, renamingContributions, renameableNodeTypes);\r
+    }\r
+\r
+    private boolean testContributions(\r
+            ReadGraph graph,\r
+            NodeContext parent,\r
+            NodeTypeMultiMap<TestContribution> contributions,\r
+            Set<Resource> allowedSpecialTypes) throws DatabaseException {\r
+        NodeType nodeType = getNodeType(graph, parent);\r
+        if (nodeType == null)\r
+            // Return true for now if node type is not available\r
+            // to prevent older and more custom solutions such as\r
+            // property view tables from breaking up.\r
+            return true;\r
+\r
+        // TODO: this is a previous temporary solution that should probably be removed\r
+        if (nodeType instanceof SpecialNodeType\r
+                && allowedSpecialTypes.contains(((SpecialNodeType) nodeType).resource))\r
+            return true;\r
+\r
+        for (TestContribution contribution : contributions.get(graph, nodeType)) { \r
+            if (!contribution.test(graph, parent))\r
+                return false;\r
+        }\r
+        return true;\r
+    }\r
+\r
+}\r