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
10 * VTT Technical Research Centre of Finland - initial API and implementation
\r
11 *******************************************************************************/
\r
12 package org.simantics.db.common.request;
\r
14 import org.simantics.db.AsyncRequestProcessor;
\r
15 import org.simantics.db.Operation;
\r
16 import org.simantics.db.RequestProcessor;
\r
17 import org.simantics.db.VirtualGraph;
\r
18 import org.simantics.db.exception.DatabaseException;
\r
19 import org.simantics.db.procedure.Procedure;
\r
20 import org.simantics.db.request.UndoTraits;
\r
21 import org.simantics.db.request.Write;
\r
22 import org.simantics.db.request.WriteInterface;
\r
23 import org.simantics.utils.datastructures.Callback;
\r
27 * TODO: fix this javadoc to document the correct class!!
\r
32 * Synchronous read without checked exceptions:
\r
35 * Resource r = new SimpleReadGraphRequest<Resource>(session) {
\r
37 * public Resource run(Graph g) {
\r
38 * Resource r = doSomethingThatMayFail();
\r
45 * Synchronous read with a selected checked exception that may be thrown:
\r
48 * Resource r = new SimpleReadGraphRequest<Resource>(session) {
\r
50 * public Resource run(Graph g) throws CheckedException {
\r
51 * Resource r = doSomethingThatMayFailWithCheckedException();
\r
54 * }.sync(CheckedException.class);
\r
58 * Asynchronous read with a completed() method for examining the result:
\r
61 * Resource r = new SimpleReadGraphRequest<Resource>(session) {
\r
63 * public Resource run(Graph g) {
\r
64 * Resource r = doSomethingThatMayFail();
\r
67 * public void completed(Resource result) {
\r
68 * // quickly dispatch the result somewhere, do nothing serious in this code.
\r
73 * @param <T> the result type
\r
75 public abstract class WriteRequest implements Write, UndoTraits, WriteInterface<Object> {
\r
77 private final VirtualGraph provider;
\r
79 public WriteRequest() {
\r
80 this.provider = null;
\r
83 public WriteRequest(VirtualGraph provider) {
\r
84 this.provider = provider;
\r
88 public void commitOk(Operation op) {
\r
92 final public VirtualGraph getProvider() {
\r
97 public UndoTraits getUndoTraits() {
\r
103 public void request(AsyncRequestProcessor processor, final Procedure<Object> procedure) {
\r
104 processor.asyncRequest(this, new Callback<DatabaseException>() {
\r
107 public void run(DatabaseException parameter) {
\r
108 if(parameter != null) procedure.exception(parameter);
\r
109 else procedure.execute(null);
\r
116 public Object request(RequestProcessor processor) throws DatabaseException {
\r
117 processor.syncRequest(this);
\r