Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.model / src / org / simantics / browsing / ui / model / children / ChildRule.java

diff --git a/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/children/ChildRule.java b/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/children/ChildRule.java
new file mode 100644 (file)
index 0000000..6cb8b03
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/children/ChildRule.java
@@ -0,0 +1,40 @@
+/*******************************************************************************\r
+ * Copyright (c) 2010, 2011 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.browsing.ui.model.children;\r
+\r
+import java.util.Collection;\r
+\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.exception.DatabaseException;\r
+\r
+/**\r
+ * A child rule is a part of child contribution that tells how the child nodes are found.\r
+ * @author Hannu Niemistö\r
+ */\r
+public interface ChildRule {\r
+    /**\r
+     * Checks if the child rule is compatible with the content type.\r
+     * Because this check is made when contribution is created, \r
+     * the type of the parent content is not checked anymore in getChildren.\r
+     */\r
+    boolean isCompatible(Class<?> contentType);\r
+    \r
+    /**\r
+     * Given parent content produces child contents.\r
+     */\r
+    Collection<?> getChildren(ReadGraph graph, Object parent) throws DatabaseException;\r
+    \r
+    /**\r
+     * Given child content produces possible parent contents.\r
+     */\r
+    Collection<?> getParents(ReadGraph graph, Object child) throws DatabaseException;\r
+}\r