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