bundles/org.simantics.db/src/org/simantics/db/procedure/StatementProcedure.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.procedure;
  13
  14 import java.util.List;
  15
  16 import org.simantics.db.AsyncReadGraph;
  17 import org.simantics.db.Statement;
  18
  19 /**
  20  * @author Antti Villberg
  21  *
  22  * First execute is called k times. After this finished or exception is called exactly once.
  23  *
  24  * @param <Result> the result object type accepted by the procedure
  25  */
  26 public interface StatementProcedure extends List<Statement> {
  27
  28     /**
  29      * Invoked once for each separate result of the request with potentially
  30      * multiple results. It shall be guaranteed that all <code>execute</code>
  31      * invocations have been completed when either
  32      * {@link #finished(AsyncReadGraph)} or
  33      * {@link #exception(AsyncReadGraph, Throwable)} are called and that no
  34      * <code>execute</code> invocations will follow afterwards.
  35      *
  36      * @param graph asynchronous graph access
  37      * @param result a single result of the multiresult procedure
  38      */
  39     void execute(AsyncReadGraph graph, int s, int p, int o);
  40
  41     /**
  42      * Invoked after all {@link #execute(AsyncReadGraph, Object)} calls have
  43      * been finished successfully. This method will not be invoked if case of
  44      * errors in {@link #execute(AsyncReadGraph, Object)} or the performed
  45      * request that provides the results to this procedure.
  46      *
  47      * @param graph asynchronous graph access
  48      */
  49     void finished(AsyncReadGraph graph);
  50
  51     /**
  52      * If an error occurs in the processing of the database request that
  53      * produces the results for this procedure.
  54      *
  55      * @param graph asynchronous graph access
  56      * @param throwable the exception that occurred
  57      */
  58     void exception(AsyncReadGraph graph, Throwable throwable);
  59
  60 }