Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.db / src / org / simantics / db / VirtualGraphContext.java

diff --git a/bundles/org.simantics.db/src/org/simantics/db/VirtualGraphContext.java b/bundles/org.simantics.db/src/org/simantics/db/VirtualGraphContext.java
new file mode 100644 (file)
index 0000000..b925d19
--- /dev/null
+++ b/bundles/org.simantics.db/src/org/simantics/db/VirtualGraphContext.java
@@ -0,0 +1,70 @@
+/*******************************************************************************\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.db;\r
+\r
+import org.simantics.databoard.binding.Binding;\r
+import org.simantics.db.request.Write;\r
+import org.simantics.db.request.WriteOnly;\r
+\r
+/**\r
+ * An interface that VirtualGraphSource can use to manipulate the transient virtual graph.\r
+ * \r
+ * @author Antti Villberg\r
+ */\r
+public interface VirtualGraphContext {\r
+    \r
+       /**\r
+        * Creates a new transient resource.\r
+        * @return\r
+        */\r
+    int newResource(boolean lazy);\r
+    \r
+    void finish(int resource);\r
+    \r
+    /**\r
+     * Converts a transient or persistent resource to an integer id.\r
+     * @param resource\r
+     * @return\r
+     */\r
+    int getIndex(Resource resource);\r
+    /**\r
+     * Converts an integer id to a resource.\r
+     * @param index\r
+     * @return\r
+     */\r
+    Resource getResource(int index);\r
+    @Deprecated\r
+    void initialise(Write write);\r
+    void postModification(AsyncRequestProcessor processor, WriteOnly request);\r
+    /**\r
+     * Updates previously given result to getStatements.\r
+     * @param resource\r
+     * @param statements\r
+     */\r
+    void updateStatements(int resource, int[] statements);\r
+    /**\r
+     * Updates previously given result to getValue.\r
+     * @param resource\r
+     * @param value\r
+     * @param binding\r
+     */\r
+    void updateValue(int resource, Object value, Binding binding);\r
+//    /**\r
+//     * Makes a request to persistent graph in getStatements of getValue\r
+//     * and updates the results.\r
+//     * @param <T>\r
+//     * @param read\r
+//     * @param procedure\r
+//     */\r
+//    <T> void pending(AsyncRead<T> read, Procedure<T> procedure);\r
+\r
+}\r