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