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