Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.mapping / src / org / simantics / mapping / constraint / instructions / IInstruction.java

diff --git a/bundles/org.simantics.mapping/src/org/simantics/mapping/constraint/instructions/IInstruction.java b/bundles/org.simantics.mapping/src/org/simantics/mapping/constraint/instructions/IInstruction.java
new file mode 100644 (file)
index 0000000..4b92323
--- /dev/null
+++ b/bundles/org.simantics.mapping/src/org/simantics/mapping/constraint/instructions/IInstruction.java
@@ -0,0 +1,63 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.mapping.constraint.instructions;\r
+\r
+import gnu.trove.map.hash.TIntIntHashMap;\r
+import gnu.trove.set.hash.TIntHashSet;\r
+\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.WriteGraph;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.mapping.IContextualModification;\r
+\r
+public interface IInstruction {\r
+       \r
+       public static final boolean DEBUG = false;\r
+       public static final boolean DEBUG_MODI = false;\r
+       public static final boolean DISABLE_MODI = false; // Disables modifications, if DEBUG_MODI is true\r
+                                                         // just prints intended modifications\r
+       public static final String INDENTATION = "     ";\r
+       \r
+       /**\r
+        * Return value for query that finds no bindings.\r
+        */\r
+       public static final Object FAILURE = new Object();\r
+       \r
+       /**\r
+        * \r
+        * @param state\r
+        * @return FAILURE, if query failed\r
+        *         null, if query succeeded but there is only one possible binding\r
+        *         something else, if query succeeded and there might be more than one binding                                 \r
+        */\r
+       Object query(ReadGraph g, Object[] bindings) throws DatabaseException;\r
+       \r
+       /**\r
+        * @param state\r
+        * @param continuation\r
+        * @return FAILURE, if there are no more results\r
+        *         null, if this was the last result\r
+        *         non-null, if there were one result and may be more\r
+        */\r
+       Object next(ReadGraph g, Object[] bindings, Object continuation) throws DatabaseException;      \r
+       \r
+       IContextualModification claim(ReadGraph g, Object[] bindings) throws DatabaseException;\r
+       void doClaim(WriteGraph g, Object[] bindings) throws DatabaseException;\r
+       IContextualModification deny(ReadGraph g, Object[] bindings) throws DatabaseException;\r
+       void doDeny(WriteGraph g, Object[] bindings) throws DatabaseException;\r
+               \r
+       void collectVariables(TIntHashSet reads, TIntHashSet writes);\r
+       void mapVariables(TIntIntHashMap map);\r
+       \r
+       void toString(StringBuilder b, int indent);\r
+       \r
+}\r