X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=bundles%2Forg.simantics.db.common%2Fsrc%2Forg%2Fsimantics%2Fdb%2Fcommon%2Frequest%2FWriteRequest.java;h=cb9460d13a2b49286b8b554683be9a81157122e7;hp=76ab2016d80cc3fc230484941ac2b075e844a5fb;hb=d33a5a61e2c056a3d48733819257890406ee9d52;hpb=969bd23cab98a79ca9101af33334000879fb60c5 diff --git a/bundles/org.simantics.db.common/src/org/simantics/db/common/request/WriteRequest.java b/bundles/org.simantics.db.common/src/org/simantics/db/common/request/WriteRequest.java index 76ab2016d..cb9460d13 100644 --- a/bundles/org.simantics.db.common/src/org/simantics/db/common/request/WriteRequest.java +++ b/bundles/org.simantics.db.common/src/org/simantics/db/common/request/WriteRequest.java @@ -1,121 +1,115 @@ -/******************************************************************************* - * Copyright (c) 2007, 2010 Association for Decentralized Information Management - * in Industry THTH ry. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * VTT Technical Research Centre of Finland - initial API and implementation - *******************************************************************************/ -package org.simantics.db.common.request; - -import org.simantics.db.AsyncRequestProcessor; -import org.simantics.db.Operation; -import org.simantics.db.RequestProcessor; -import org.simantics.db.VirtualGraph; -import org.simantics.db.exception.DatabaseException; -import org.simantics.db.procedure.Procedure; -import org.simantics.db.request.UndoTraits; -import org.simantics.db.request.Write; -import org.simantics.db.request.WriteInterface; -import org.simantics.utils.datastructures.Callback; - - -/** - * TODO: fix this javadoc to document the correct class!! - * - * Usage samples: - * - *

- * Synchronous read without checked exceptions: - *

- *
- * Resource r = new SimpleReadGraphRequest<Resource>(session) {
- *     {@code @Override}
- *     public Resource run(Graph g) {
- *         Resource r = doSomethingThatMayFail();
- *         return r;
- *     }
- * }.sync();
- * 
- * - *

- * Synchronous read with a selected checked exception that may be thrown: - *

- *
- * Resource r = new SimpleReadGraphRequest<Resource>(session) {
- *     {@code @Override}
- *     public Resource run(Graph g) throws CheckedException {
- *         Resource r = doSomethingThatMayFailWithCheckedException();
- *         return r;
- *     }
- * }.sync(CheckedException.class);
- * 
- * - *

- * Asynchronous read with a completed() method for examining the result: - *

- *
- * Resource r = new SimpleReadGraphRequest<Resource>(session) {
- *     {@code @Override}
- *     public Resource run(Graph g) {
- *         Resource r = doSomethingThatMayFail();
- *         return r;
- *     }
- *     public void completed(Resource result) {
- *         // quickly dispatch the result somewhere, do nothing serious in this code.
- *     }
- * }.async();
- * 
- * - * @param the result type - */ -public abstract class WriteRequest implements Write, UndoTraits, WriteInterface { - - private final VirtualGraph provider; - - public WriteRequest() { - this.provider = null; - } - - public WriteRequest(VirtualGraph provider) { - this.provider = provider; - } - - @Override - public void commitOk(Operation op) { - } - - @Override - final public VirtualGraph getProvider() { - return provider; - } - - @Override - public UndoTraits getUndoTraits() { - return this; - } - - - @Override - public void request(AsyncRequestProcessor processor, final Procedure procedure) { - processor.asyncRequest(this, new Callback() { - - @Override - public void run(DatabaseException parameter) { - if(parameter != null) procedure.exception(parameter); - else procedure.execute(null); - } - - }); - } - - @Override - public Object request(RequestProcessor processor) throws DatabaseException { - processor.syncRequest(this); - return null; - } - -} +/******************************************************************************* + * Copyright (c) 2007, 2010 Association for Decentralized Information Management + * in Industry THTH ry. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * VTT Technical Research Centre of Finland - initial API and implementation + *******************************************************************************/ +package org.simantics.db.common.request; + +import org.simantics.db.AsyncRequestProcessor; +import org.simantics.db.Operation; +import org.simantics.db.RequestProcessor; +import org.simantics.db.VirtualGraph; +import org.simantics.db.exception.DatabaseException; +import org.simantics.db.procedure.Procedure; +import org.simantics.db.request.UndoTraits; +import org.simantics.db.request.Write; +import org.simantics.db.request.WriteInterface; +import org.simantics.utils.datastructures.Callback; + + +/** + * TODO: fix this javadoc to document the correct class!! + * + * Usage samples: + * + *

+ * Synchronous read without checked exceptions: + *

+ *
+ * Resource r = new SimpleReadGraphRequest<Resource>(session) {
+ *     {@code @Override}
+ *     public Resource run(Graph g) {
+ *         Resource r = doSomethingThatMayFail();
+ *         return r;
+ *     }
+ * }.sync();
+ * 
+ * + *

+ * Synchronous read with a selected checked exception that may be thrown: + *

+ *
+ * Resource r = new SimpleReadGraphRequest<Resource>(session) {
+ *     {@code @Override}
+ *     public Resource run(Graph g) throws CheckedException {
+ *         Resource r = doSomethingThatMayFailWithCheckedException();
+ *         return r;
+ *     }
+ * }.sync(CheckedException.class);
+ * 
+ * + *

+ * Asynchronous read with a completed() method for examining the result: + *

+ *
+ * Resource r = new SimpleReadGraphRequest<Resource>(session) {
+ *     {@code @Override}
+ *     public Resource run(Graph g) {
+ *         Resource r = doSomethingThatMayFail();
+ *         return r;
+ *     }
+ *     public void completed(Resource result) {
+ *         // quickly dispatch the result somewhere, do nothing serious in this code.
+ *     }
+ * }.async();
+ * 
+ * + * @param the result type + */ +public abstract class WriteRequest implements Write, UndoTraits, WriteInterface { + + private final VirtualGraph provider; + + public WriteRequest() { + this.provider = null; + } + + public WriteRequest(VirtualGraph provider) { + this.provider = provider; + } + + @Override + public void commitOk(Operation op) { + } + + @Override + final public VirtualGraph getProvider() { + return provider; + } + + @Override + public void request(AsyncRequestProcessor processor, final Procedure procedure) { + processor.asyncRequest(this, new Callback() { + + @Override + public void run(DatabaseException parameter) { + if(parameter != null) procedure.exception(parameter); + else procedure.execute(null); + } + + }); + } + + @Override + public Object request(RequestProcessor processor) throws DatabaseException { + processor.syncRequest(this); + return null; + } + +}