Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.db.common / src / org / simantics / db / common / request / WriteResultRequest.java

diff --git a/bundles/org.simantics.db.common/src/org/simantics/db/common/request/WriteResultRequest.java b/bundles/org.simantics.db.common/src/org/simantics/db/common/request/WriteResultRequest.java
new file mode 100644 (file)
index 0000000..823616c
--- /dev/null
+++ b/bundles/org.simantics.db.common/src/org/simantics/db/common/request/WriteResultRequest.java
@@ -0,0 +1,103 @@
+/*******************************************************************************\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.common.request;\r
+\r
+import org.simantics.db.AsyncRequestProcessor;\r
+import org.simantics.db.RequestProcessor;\r
+import org.simantics.db.VirtualGraph;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.db.procedure.Procedure;\r
+import org.simantics.db.request.UndoTraits;\r
+import org.simantics.db.request.WriteInterface;\r
+import org.simantics.db.request.WriteResult;\r
+\r
+\r
+/**\r
+ * Usage samples:\r
+ * \r
+ * <p>\r
+ * Synchronous read without checked exceptions:\r
+ * </p>\r
+ * <pre>\r
+ * Resource r = new SimpleReadGraphRequest&lt;Resource&gt;(session) {\r
+ *     {@code @Override}\r
+ *     public Resource run(Graph g) {\r
+ *         Resource r = doSomethingThatMayFail();\r
+ *         return r;\r
+ *     }\r
+ * }.sync();\r
+ * </pre>\r
+ * \r
+ * <p>\r
+ * Synchronous read with a selected checked exception that may be thrown:\r
+ * </p>\r
+ * <pre>\r
+ * Resource r = new SimpleReadGraphRequest&lt;Resource&gt;(session) {\r
+ *     {@code @Override}\r
+ *     public Resource run(Graph g) throws CheckedException {\r
+ *         Resource r = doSomethingThatMayFailWithCheckedException();\r
+ *         return r;\r
+ *     }\r
+ * }.sync(CheckedException.class);\r
+ * </pre>\r
+ * \r
+ * <p>\r
+ * Asynchronous read with a completed() method for examining the result:\r
+ * </p>\r
+ * <pre>\r
+ * Resource r = new SimpleReadGraphRequest&lt;Resource&gt;(session) {\r
+ *     {@code @Override}\r
+ *     public Resource run(Graph g) {\r
+ *         Resource r = doSomethingThatMayFail();\r
+ *         return r;\r
+ *     }\r
+ *     public void completed(Resource result) {\r
+ *         // quickly dispatch the result somewhere, do nothing serious in this code.\r
+ *     }\r
+ * }.async();\r
+ * </pre>\r
+ * \r
+ * @param <T> the result type\r
+ */\r
+public abstract class WriteResultRequest<T> implements WriteResult<T>, WriteInterface<T> {\r
+\r
+    private final VirtualGraph provider;\r
+\r
+    public WriteResultRequest() {\r
+        this.provider = null;\r
+    }\r
+\r
+    public WriteResultRequest(VirtualGraph provider) {\r
+        this.provider = provider;\r
+    }\r
+    \r
+    @Override\r
+    final public VirtualGraph getProvider() {\r
+        return provider;\r
+    }\r
+    \r
+    @Override\r
+    public UndoTraits getUndoTraits() {\r
+       return null;\r
+    }\r
+\r
+    @Override\r
+    public void request(AsyncRequestProcessor processor, final Procedure<T> procedure) {\r
+       processor.asyncRequest(this, procedure);\r
+    }\r
+    \r
+    @Override\r
+    public T request(RequestProcessor processor) throws DatabaseException {\r
+       return processor.syncRequest(this);\r
+    }\r
+    \r
+}\r