bundles/org.simantics.db.common/src/org/simantics/db/common/request/WriteRequest.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.db.common.request;\r
  13 \r
  14 import org.simantics.db.AsyncRequestProcessor;\r
  15 import org.simantics.db.Operation;\r
  16 import org.simantics.db.RequestProcessor;\r
  17 import org.simantics.db.VirtualGraph;\r
  18 import org.simantics.db.exception.DatabaseException;\r
  19 import org.simantics.db.procedure.Procedure;\r
  20 import org.simantics.db.request.UndoTraits;\r
  21 import org.simantics.db.request.Write;\r
  22 import org.simantics.db.request.WriteInterface;\r
  23 import org.simantics.utils.datastructures.Callback;\r
  24 \r
  25 \r
  26 /**\r
  27  * TODO: fix this javadoc to document the correct class!!\r
  28  * \r
  29  * Usage samples:\r
  30  * \r
  31  * <p>\r
  32  * Synchronous read without checked exceptions:\r
  33  * </p>\r
  34  * <pre>\r
  35  * Resource r = new SimpleReadGraphRequest&lt;Resource&gt;(session) {\r
  36  *     {@code @Override}\r
  37  *     public Resource run(Graph g) {\r
  38  *         Resource r = doSomethingThatMayFail();\r
  39  *         return r;\r
  40  *     }\r
  41  * }.sync();\r
  42  * </pre>\r
  43  * \r
  44  * <p>\r
  45  * Synchronous read with a selected checked exception that may be thrown:\r
  46  * </p>\r
  47  * <pre>\r
  48  * Resource r = new SimpleReadGraphRequest&lt;Resource&gt;(session) {\r
  49  *     {@code @Override}\r
  50  *     public Resource run(Graph g) throws CheckedException {\r
  51  *         Resource r = doSomethingThatMayFailWithCheckedException();\r
  52  *         return r;\r
  53  *     }\r
  54  * }.sync(CheckedException.class);\r
  55  * </pre>\r
  56  * \r
  57  * <p>\r
  58  * Asynchronous read with a completed() method for examining the result:\r
  59  * </p>\r
  60  * <pre>\r
  61  * Resource r = new SimpleReadGraphRequest&lt;Resource&gt;(session) {\r
  62  *     {@code @Override}\r
  63  *     public Resource run(Graph g) {\r
  64  *         Resource r = doSomethingThatMayFail();\r
  65  *         return r;\r
  66  *     }\r
  67  *     public void completed(Resource result) {\r
  68  *         // quickly dispatch the result somewhere, do nothing serious in this code.\r
  69  *     }\r
  70  * }.async();\r
  71  * </pre>\r
  72  * \r
  73  * @param <T> the result type\r
  74  */\r
  75 public abstract class WriteRequest implements Write, UndoTraits, WriteInterface<Object> {\r
  76 \r
  77     private final VirtualGraph provider;\r
  78     \r
  79     public WriteRequest() {\r
  80         this.provider = null;\r
  81     }\r
  82 \r
  83     public WriteRequest(VirtualGraph provider) {\r
  84         this.provider = provider;\r
  85     }\r
  86 \r
  87     @Override\r
  88     public void commitOk(Operation op) {\r
  89     }\r
  90 \r
  91     @Override\r
  92     final public VirtualGraph getProvider() {\r
  93         return provider;\r
  94     }\r
  95 \r
  96     @Override\r
  97     public UndoTraits getUndoTraits() {\r
  98         return this;\r
  99     }\r
 100 \r
 101     \r
 102     @Override\r
 103     public void request(AsyncRequestProcessor processor, final Procedure<Object> procedure) {\r
 104         processor.asyncRequest(this, new Callback<DatabaseException>() {\r
 105                         \r
 106                         @Override\r
 107                         public void run(DatabaseException parameter) {\r
 108                                 if(parameter != null) procedure.exception(parameter);\r
 109                                 else procedure.execute(null);\r
 110                         }\r
 111                         \r
 112                 });\r
 113     }\r
 114     \r
 115     @Override\r
 116     public Object request(RequestProcessor processor) throws DatabaseException {\r
 117         processor.syncRequest(this);\r
 118         return null;\r
 119     }\r
 120 \r
 121 }\r