Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.objmap2 / src / org / simantics / objmap / forward / IForwardMappingRule.java

diff --git a/bundles/org.simantics.objmap2/src/org/simantics/objmap/forward/IForwardMappingRule.java b/bundles/org.simantics.objmap2/src/org/simantics/objmap/forward/IForwardMappingRule.java
new file mode 100644 (file)
index 0000000..b64acc9
--- /dev/null
+++ b/bundles/org.simantics.objmap2/src/org/simantics/objmap/forward/IForwardMappingRule.java
@@ -0,0 +1,29 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2013 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.objmap.forward;\r
+\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.objmap.exceptions.MappingException;\r
+\r
+public interface IForwardMappingRule<Domain, Range> {\r
+       /**\r
+        * Modifies the range element so that it corresponds to the domain element.\r
+        * @param g read transaction\r
+        * @param map unidirectional view of the current mapping\r
+        * @param domainElement the domain element that corresponds to the range element\r
+        * @param rangeElement the range element that is updated\r
+        * @return true if the rule made some modifications\r
+        * @throws MappingException\r
+        */\r
+       boolean updateRange(ReadGraph graph, IForwardMapping<Domain, Range> mapping, Domain domainElement, Range rangeElement) throws MappingException; \r
+       void createRange(ReadGraph graph, IForwardMapping<Domain, Range> mapping, Domain domainElement, Range rangeElement) throws MappingException;\r
+}\r