Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.objmap2 / src / org / simantics / objmap / backward / IBackwardMapping.java

diff --git a/bundles/org.simantics.objmap2/src/org/simantics/objmap/backward/IBackwardMapping.java b/bundles/org.simantics.objmap2/src/org/simantics/objmap/backward/IBackwardMapping.java
new file mode 100644 (file)
index 0000000..c48e98b
--- /dev/null
+++ b/bundles/org.simantics.objmap2/src/org/simantics/objmap/backward/IBackwardMapping.java
@@ -0,0 +1,30 @@
+/*******************************************************************************\r
+ * Copyright (c) 2012, 2013 Association for Decentralized Information Management in\r
+ * 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.backward;\r
+\r
+import java.util.Set;\r
+\r
+import org.simantics.db.WriteGraph;\r
+import org.simantics.objmap.exceptions.MappingException;\r
+\r
+/**\r
+ * A backward mapping is a one-to-one correspondence between domain and range\r
+ * elements. It supports adding new range elements and creating corresponding\r
+ * domain elements.\r
+ * \r
+ * @author Hannu Niemistö\r
+ */\r
+public interface IBackwardMapping<Domain, Range> {\r
+    Set<Range> getRange();\r
+    Domain inverseGet(Range rangeElement);\r
+    Domain inverseMap(WriteGraph graph, Range rangeElement) throws MappingException;\r
+}\r