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.mapping.constraint.instructions;
\r
14 import gnu.trove.map.hash.TIntIntHashMap;
\r
15 import gnu.trove.set.hash.TIntHashSet;
\r
17 import org.simantics.db.ReadGraph;
\r
18 import org.simantics.db.WriteGraph;
\r
19 import org.simantics.db.exception.DatabaseException;
\r
20 import org.simantics.mapping.IContextualModification;
\r
22 public interface IInstruction {
\r
24 public static final boolean DEBUG = false;
\r
25 public static final boolean DEBUG_MODI = false;
\r
26 public static final boolean DISABLE_MODI = false; // Disables modifications, if DEBUG_MODI is true
\r
27 // just prints intended modifications
\r
28 public static final String INDENTATION = " ";
\r
31 * Return value for query that finds no bindings.
\r
33 public static final Object FAILURE = new Object();
\r
38 * @return FAILURE, if query failed
\r
39 * null, if query succeeded but there is only one possible binding
\r
40 * something else, if query succeeded and there might be more than one binding
\r
42 Object query(ReadGraph g, Object[] bindings) throws DatabaseException;
\r
46 * @param continuation
\r
47 * @return FAILURE, if there are no more results
\r
48 * null, if this was the last result
\r
49 * non-null, if there were one result and may be more
\r
51 Object next(ReadGraph g, Object[] bindings, Object continuation) throws DatabaseException;
\r
53 IContextualModification claim(ReadGraph g, Object[] bindings) throws DatabaseException;
\r
54 void doClaim(WriteGraph g, Object[] bindings) throws DatabaseException;
\r
55 IContextualModification deny(ReadGraph g, Object[] bindings) throws DatabaseException;
\r
56 void doDeny(WriteGraph g, Object[] bindings) throws DatabaseException;
\r
58 void collectVariables(TIntHashSet reads, TIntHashSet writes);
\r
59 void mapVariables(TIntIntHashMap map);
\r
61 void toString(StringBuilder b, int indent);
\r