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