Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.graph.impl / src / org / simantics / browsing / ui / graph / impl / contribution / FinalLabelerContributionImpl.java

diff --git a/bundles/org.simantics.browsing.ui.graph.impl/src/org/simantics/browsing/ui/graph/impl/contribution/FinalLabelerContributionImpl.java b/bundles/org.simantics.browsing.ui.graph.impl/src/org/simantics/browsing/ui/graph/impl/contribution/FinalLabelerContributionImpl.java
new file mode 100644 (file)
index 0000000..83bdbe2
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.graph.impl/src/org/simantics/browsing/ui/graph/impl/contribution/FinalLabelerContributionImpl.java
@@ -0,0 +1,173 @@
+/*******************************************************************************\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.browsing.ui.graph.impl.contribution;\r
+\r
+import java.util.Collections;\r
+import java.util.Map;\r
+\r
+import org.simantics.Simantics;\r
+import org.simantics.browsing.ui.BuiltinKeys;\r
+import org.simantics.browsing.ui.BuiltinKeys.LabelerKey;\r
+import org.simantics.browsing.ui.DataSource;\r
+import org.simantics.browsing.ui.GraphExplorer.ModificationContext;\r
+import org.simantics.browsing.ui.NodeContext;\r
+import org.simantics.browsing.ui.PrimitiveQueryUpdater;\r
+import org.simantics.browsing.ui.common.labelers.LabelerContent;\r
+import org.simantics.browsing.ui.common.labelers.LabelerStub;\r
+import org.simantics.browsing.ui.common.node.IModifiableNode;\r
+import org.simantics.browsing.ui.graph.impl.request.ResourceQuery;\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.UndoContext;\r
+import org.simantics.db.common.utils.Logger;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.db.layer0.exception.InvalidVariableException;\r
+import org.simantics.db.layer0.exception.PendingVariableException;\r
+import org.simantics.db.procedure.Listener;\r
+import org.simantics.db.procedure.Procedure;\r
+import org.simantics.db.request.Read;\r
+import org.simantics.utils.ui.ErrorLogger;\r
+\r
+public abstract class FinalLabelerContributionImpl extends LabelerStub {\r
+\r
+    protected final PrimitiveQueryUpdater       updater;\r
+    private final ResourceQuery<LabelerContent> labelQuery;\r
+\r
+    final protected NodeContext                context;\r
+    final private BuiltinKeys.LabelerKey    key;\r
+\r
+    public Object getIdentity(LabelerKey key) {\r
+        return key;\r
+    }\r
+\r
+    public FinalLabelerContributionImpl(final PrimitiveQueryUpdater updater, final NodeContext context, final LabelerKey key) {\r
+\r
+        this.updater = updater;\r
+        this.context = context;\r
+        this.key = key;\r
+\r
+        labelQuery = new ResourceQuery<LabelerContent>(getIdentity(key), context) {\r
+\r
+            @Override\r
+            public LabelerContent perform(ReadGraph graph) throws DatabaseException {\r
+                try {\r
+                    int cat = category(graph, context);\r
+                    Map<String, String> lbls = labels(graph, context);\r
+                    // Make sure that null is not returned.\r
+                    if (lbls == null)\r
+                        throw new NullPointerException("FinalLabelerContributionImpl.labels is not allowed to return null, but " + FinalLabelerContributionImpl.this.getClass() + " just did it");\r
+                    return new LabelerContent(cat, lbls);\r
+                } catch (PendingVariableException e) {\r
+                    return LabelerContent.NO_CONTENT;\r
+                } catch (InvalidVariableException e) {\r
+                    //ErrorLogger.defaultLogError("FinalLabelerContributionImpl.labelQuery failed due to invalid variable.", e);\r
+                    return LabelerContent.NO_CONTENT;\r
+                } catch (DatabaseException e) {\r
+                    throw e;\r
+                } catch (Throwable t) {\r
+                    ErrorLogger.defaultLogError("FinalLabelerContributionImpl.labelQuery produced unexpected exception.", t);\r
+                    return LabelerContent.NO_CONTENT;\r
+                }\r
+            }\r
+\r
+            @Override\r
+            public String toString() {\r
+                return FinalLabelerContributionImpl.this + " with context " + context;\r
+            }\r
+\r
+        };\r
+\r
+    }\r
+\r
+    protected Procedure<LabelerContent> createProcedure() {\r
+\r
+        return new Procedure<LabelerContent>() {\r
+\r
+            @Override\r
+            public void execute(LabelerContent result) {\r
+                replaceResult(result);\r
+            }\r
+\r
+            @Override\r
+            public void exception(Throwable t) {\r
+                ErrorLogger.defaultLogError("FinalLabelerContributionImpl.labelQuery failed, see exception for details.", t);\r
+            }\r
+\r
+        };\r
+\r
+    }\r
+\r
+    protected void replaceResult(LabelerContent result) {\r
+        setContent(result);\r
+        updater.scheduleReplace(context, key, this);\r
+    }\r
+\r
+    @Override\r
+    public Map<String, String> getLabels() {\r
+\r
+        if (content == LabelerContent.NO_CONTENT) {\r
+\r
+            final DataSource<ReadGraph> source = updater.getDataSource(ReadGraph.class);\r
+            assert(source != null);\r
+\r
+            final Procedure<LabelerContent> procedure = createProcedure();\r
+            \r
+            source.schedule(graph -> {\r
+                if(procedure instanceof Listener<?>)\r
+                    graph.asyncRequest(labelQuery, (Listener<LabelerContent>)procedure);\r
+                else\r
+                    graph.asyncRequest(labelQuery, procedure);\r
+            });\r
+\r
+        }\r
+\r
+        if(content == null) return Collections.emptyMap();\r
+\r
+        return content.labels;\r
+\r
+    }\r
+\r
+    @Override\r
+    public Modifier getModifier(final ModificationContext modificationContext, final String columnKey) {\r
+       \r
+        Object obj = context.getConstant(BuiltinKeys.INPUT);\r
+        if (obj instanceof IModifiableNode) {\r
+            return ((IModifiableNode) obj).getModifier(columnKey);\r
+        }\r
+        try {\r
+                       return Simantics.getSession().syncRequest(new Read<Modifier>() {\r
+\r
+                               @Override\r
+                               public Modifier perform(ReadGraph graph) throws DatabaseException {\r
+                                   UndoContext undoContext = null == modificationContext ? null :\r
+                                       (UndoContext)modificationContext.getAdapter(UndoContext.class);\r
+                                       return FinalLabelerContributionImpl.this.getModifier(graph, undoContext, context, columnKey);\r
+                               }\r
+                               \r
+                       });\r
+               } catch (DatabaseException e) {\r
+                       Logger.defaultLogError(e);\r
+                       return null;\r
+               }\r
+        \r
+    }\r
+\r
+    // OVERRIDE\r
+\r
+    public Modifier getModifier(ReadGraph graph, UndoContext undoContext, NodeContext context, String columnKey) throws DatabaseException {\r
+       return null;\r
+    }\r
+\r
+    public abstract Map<String, String> labels(ReadGraph graph, NodeContext context) throws DatabaseException;\r
+\r
+    public abstract int category(ReadGraph graph, NodeContext context) throws DatabaseException;\r
+\r
+}\r