bundles/org.simantics.db.common/src/org/simantics/db/common/request/WriteResultRequest.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.RequestProcessor;\r
  16 import org.simantics.db.VirtualGraph;\r
  17 import org.simantics.db.exception.DatabaseException;\r
  18 import org.simantics.db.procedure.Procedure;\r
  19 import org.simantics.db.request.UndoTraits;\r
  20 import org.simantics.db.request.WriteInterface;\r
  21 import org.simantics.db.request.WriteResult;\r
  22 \r
  23 \r
  24 /**\r
  25  * Usage samples:\r
  26  * \r
  27  * <p>\r
  28  * Synchronous read without checked exceptions:\r
  29  * </p>\r
  30  * <pre>\r
  31  * Resource r = new SimpleReadGraphRequest&lt;Resource&gt;(session) {\r
  32  *     {@code @Override}\r
  33  *     public Resource run(Graph g) {\r
  34  *         Resource r = doSomethingThatMayFail();\r
  35  *         return r;\r
  36  *     }\r
  37  * }.sync();\r
  38  * </pre>\r
  39  * \r
  40  * <p>\r
  41  * Synchronous read with a selected checked exception that may be thrown:\r
  42  * </p>\r
  43  * <pre>\r
  44  * Resource r = new SimpleReadGraphRequest&lt;Resource&gt;(session) {\r
  45  *     {@code @Override}\r
  46  *     public Resource run(Graph g) throws CheckedException {\r
  47  *         Resource r = doSomethingThatMayFailWithCheckedException();\r
  48  *         return r;\r
  49  *     }\r
  50  * }.sync(CheckedException.class);\r
  51  * </pre>\r
  52  * \r
  53  * <p>\r
  54  * Asynchronous read with a completed() method for examining the result:\r
  55  * </p>\r
  56  * <pre>\r
  57  * Resource r = new SimpleReadGraphRequest&lt;Resource&gt;(session) {\r
  58  *     {@code @Override}\r
  59  *     public Resource run(Graph g) {\r
  60  *         Resource r = doSomethingThatMayFail();\r
  61  *         return r;\r
  62  *     }\r
  63  *     public void completed(Resource result) {\r
  64  *         // quickly dispatch the result somewhere, do nothing serious in this code.\r
  65  *     }\r
  66  * }.async();\r
  67  * </pre>\r
  68  * \r
  69  * @param <T> the result type\r
  70  */\r
  71 public abstract class WriteResultRequest<T> implements WriteResult<T>, WriteInterface<T> {\r
  72 \r
  73     private final VirtualGraph provider;\r
  74 \r
  75     public WriteResultRequest() {\r
  76         this.provider = null;\r
  77     }\r
  78 \r
  79     public WriteResultRequest(VirtualGraph provider) {\r
  80         this.provider = provider;\r
  81     }\r
  82     \r
  83     @Override\r
  84     final public VirtualGraph getProvider() {\r
  85         return provider;\r
  86     }\r
  87     \r
  88     @Override\r
  89     public UndoTraits getUndoTraits() {\r
  90         return null;\r
  91     }\r
  92 \r
  93     @Override\r
  94     public void request(AsyncRequestProcessor processor, final Procedure<T> procedure) {\r
  95         processor.asyncRequest(this, procedure);\r
  96     }\r
  97     \r
  98     @Override\r
  99     public T request(RequestProcessor processor) throws DatabaseException {\r
 100         return processor.syncRequest(this);\r
 101     }\r
 102     \r
 103 }\r