Make Write-interfaces as @FunctionalInterface for lambdas
[simantics/platform.git] / bundles / org.simantics.db / src / org / simantics / db / request / WriteOnly.java
1 /*******************************************************************************
2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
3  * in Industry THTH ry.
4  * All rights reserved. This program and the accompanying materials
5  * are made available under the terms of the Eclipse Public License v1.0
6  * which accompanies this distribution, and is available at
7  * http://www.eclipse.org/legal/epl-v10.html
8  *
9  * Contributors:
10  *     VTT Technical Research Centre of Finland - initial API and implementation
11  *******************************************************************************/
12 package org.simantics.db.request;
13
14 import org.simantics.db.Session;
15 import org.simantics.db.WriteOnlyGraph;
16 import org.simantics.db.exception.CancelTransactionException;
17 import org.simantics.db.exception.DatabaseException;
18
19 /**
20  * TODO: fix this AGE OLD documentation !! This is totally out of date.
21  * 
22  * The <code>GraphRequest</code> interface is used to create transaction
23  * requests to Simantics database implementations. Both read and write
24  * transaction requests use the same interface.
25  * 
26  * <p>
27  * The actual work carried out by the implemented request should be done in the
28  * <code>perform</code> method. It receives a <code>WriteOnlyGraph</code> instance as
29  * the only argument which is the interface for actually reading and writing the
30  * graph data model.
31  * 
32  * <p>
33  * Transaction requests can be made to the database by creating your own
34  * <code>GraphRequest</code> instance and putting it in the request queue of
35  * the database session through the {@link Session} interface. The database
36  * session is responsible for executing the queued requests in a thread of its
37  * choice, or possibly/preferably multiple threads. The database session can
38  * allow multiple read-only requests to occur simultaneously, but read-write
39  * requests require exclusive database access. In other words only one
40  * read-write request can be in execution simultaneously.
41  * 
42  * <p>
43  * This interface also has two callbacks - <code>handleException</code> for
44  * allowing handling any exceptions thrown by <code>perform</code> and
45  * <code>requestCompleted</code> for performing actions after a request has
46  * been successfully completed.
47  * 
48  * <p>
49  * Clients of this interface are encouraged to extend the provided abstract
50  * implementations or this class or extend their own helper implementations for
51  * ones particular needs. The provided abstract implementations are:
52  * <ul>
53  * <li>{@link ReadGraphRequestAdapter} provides default implementations for
54  * everything except {@link #perform(WriteOnlyGraph)}.</li>
55  * <li>{@link SimpleGraphRequest} replaces {@link #perform(WriteOnlyGraph)} with
56  * {@link SimpleGraphRequest#run(WriteOnlyGraph)} for easier request implementation in
57  * simple cases.</li>
58  * <li>{@link GraphRequestWithResult} makes it easier for the user to return
59  * a single result Object from the request.</li>
60  * </ul>
61  * 
62  * @author Tuukka Lehtonen
63  * @see ReadGraphRequestAdapter
64  * @see GraphRequestRunner
65  * @see GraphRequestStatus
66  * @see GraphRequestWithResult
67  * @see Session
68  * @see SimpleGraphRequest
69  */
70 @FunctionalInterface
71 public interface WriteOnly extends WriteTraits {
72
73     /**
74      * When a <code>GraphRequest</code> is serviced by the database session
75      * the method <code>perform</code> is invoked.
76      * 
77      * <p>
78      * Perform receives an object instance implementing the <code>WriteOnlyGraph</code>
79      * interface which provides the only way to read/write the graph data model.
80      * The Graph instance must only be valid during the execution of the
81      * <code>perform</code> method and therefore should not be stored for use
82      * outside of its execution.
83      * 
84      * <p>
85      * The general contract of the method <code>perform</code> is that it may
86      * take any action whatsoever which involves reading or writing the data
87      * model through the received Graph instance.
88      * 
89      * @param g an interface for reading and writing the data model
90      * @return the result status of the request which affects how the
91      *         transaction proceeds, see GraphRequestStatus for more information
92      * @throws Exception when anything goes wrong inside the request thread
93      * @throws CancelTransactionException to indicate that the request needs to
94      *         be cancelled and any changes rolled back
95      */
96     void perform(WriteOnlyGraph graph) throws DatabaseException;
97
98 }