bundles/org.simantics.db/src/org/simantics/db/request/WriteResult.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.request;\r
  13 \r
  14 import org.simantics.db.Session;\r
  15 import org.simantics.db.WriteGraph;\r
  16 import org.simantics.db.exception.CancelTransactionException;\r
  17 import org.simantics.db.exception.DatabaseException;\r
  18 \r
  19 /**\r
  20  * The <code>GraphRequest</code> interface is used to create transaction\r
  21  * requests to Simantics database implementations. Both read and write\r
  22  * transaction requests use the same interface.\r
  23  * \r
  24  * <p>\r
  25  * The actual work carried out by the implemented request should be done in the\r
  26  * <code>perform</code> method. It receives a <code>Graph</code> instance as\r
  27  * the only argument which is the interface for actually reading and writing the\r
  28  * graph data model.\r
  29  * \r
  30  * <p>\r
  31  * Transaction requests can be made to the database by creating your own\r
  32  * <code>GraphRequest</code> instance and putting it in the request queue of\r
  33  * the database session through the {@link Session} interface. The database\r
  34  * session is responsible for executing the queued requests in a thread of its\r
  35  * choice, or possibly/preferably multiple threads. The database session can\r
  36  * allow multiple read-only requests to occur simultaneously, but read-write\r
  37  * requests require exclusive database access. In other words only one\r
  38  * read-write request can be in execution simultaneously.\r
  39  * \r
  40  * <p>\r
  41  * This interface also has two callbacks - <code>handleException</code> for\r
  42  * allowing handling any exceptions thrown by <code>perform</code> and\r
  43  * <code>requestCompleted</code> for performing actions after a request has\r
  44  * been successfully completed.\r
  45  * \r
  46  * <p>\r
  47  * Clients of this interface are encouraged to extend the provided abstract\r
  48  * implementations or this class or extend their own helper implementations for\r
  49  * ones particular needs. The provided abstract implementations are:\r
  50  * <ul>\r
  51  * <li>{@link ReadGraphRequestAdapter} provides default implementations for\r
  52  * everything except {@link #perform(WriteGraph)}.</li>\r
  53  * <li>{@link SimpleGraphRequest} replaces {@link #perform(WriteGraph)} with\r
  54  * {@link SimpleGraphRequest#run(WriteGraph)} for easier request implementation in\r
  55  * simple cases.</li>\r
  56  * <li>{@link GraphRequestWithResult} makes it easier for the user to return\r
  57  * a single result Object from the request.</li>\r
  58  * </ul>\r
  59  * \r
  60  * @author Tuukka Lehtonen\r
  61  * @see ReadGraphRequestAdapter\r
  62  * @see GraphRequestRunner\r
  63  * @see GraphRequestStatus\r
  64  * @see GraphRequestWithResult\r
  65  * @see Session\r
  66  * @see SimpleGraphRequest\r
  67  */\r
  68 public interface WriteResult<T> extends WriteTraits {\r
  69 \r
  70     /**\r
  71      * When a <code>GraphRequest</code> is serviced by the database session\r
  72      * the method <code>perform</code> is invoked.\r
  73      * \r
  74      * <p>\r
  75      * Perform receives an object instance implementing the <code>Graph</code>\r
  76      * interface which provides the only way to read/write the graph data model.\r
  77      * The Graph instance must only be valid during the execution of the\r
  78      * <code>perform</code> method and therefore should not be stored for use\r
  79      * outside of its execution.\r
  80      * \r
  81      * <p>\r
  82      * The general contract of the method <code>perform</code> is that it may\r
  83      * take any action whatsoever which involves reading or writing the data\r
  84      * model through the received Graph instance.\r
  85      * \r
  86      * @param g an interface for reading and writing the data model\r
  87      * @return the result status of the request which affects how the\r
  88      *         transaction proceeds, see GraphRequestStatus for more information\r
  89      * @throws Exception when anything goes wrong inside the request thread\r
  90      * @throws CancelTransactionException to indicate that the request needs to\r
  91      *         be cancelled and any changes rolled back\r
  92      */\r
  93     T perform(WriteGraph graph) throws DatabaseException;\r
  94     \r
  95 }\r