Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.model / src / org / simantics / browsing / ui / model / nodetypes / NodeType.java

diff --git a/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/nodetypes/NodeType.java b/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/nodetypes/NodeType.java
new file mode 100644 (file)
index 0000000..9ee9eec
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.model/src/org/simantics/browsing/ui/model/nodetypes/NodeType.java
@@ -0,0 +1,76 @@
+/*******************************************************************************\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.nodetypes;\r
+\r
+import java.util.Collection;\r
+\r
+import org.simantics.browsing.ui.BuiltinKeys;\r
+import org.simantics.browsing.ui.NodeContext;\r
+import org.simantics.browsing.ui.NodeContext.ConstantKey;\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.ui.selection.WorkbenchSelectionElement;\r
+\r
+/**\r
+ * Node type specifies the content type and role of the node in \r
+ * the model browser.\r
+ * @author Hannu Niemistö\r
+ */\r
+public interface NodeType {\r
+\r
+    public static class TypeKey implements ConstantKey<NodeType> {\r
+        private TypeKey() {}\r
+        @Override\r
+        public String toString() {\r
+            return "TYPE";\r
+        }\r
+    };\r
+    public static final ConstantKey<NodeType> TYPE = new TypeKey();\r
+\r
+    public static final ConstantKey<?>[] KEY_SEQUENCE = new ConstantKey<?>[] {\r
+        BuiltinKeys.INPUT,\r
+        TYPE\r
+    };\r
+\r
+    public static final ConstantKey<?>[] KEY_SEQUENCE_EXT = new ConstantKey<?>[] {\r
+        BuiltinKeys.INPUT,\r
+        TYPE,\r
+        BuiltinKeys.UI_CONTEXT,\r
+        BuiltinKeys.BROWSE_CONTEXT,\r
+        BuiltinKeys.ACTION_BROWSE_CONTEXT\r
+    };\r
+    \r
+    /**\r
+     * Creates a node context from the content. If the content is not\r
+     * suitable for this node type, returns null. This method cannot\r
+     * assume anything about the Java type of the content given as\r
+     * a parameter, but if it returns a node its content must be \r
+     * an instance of the Java class given by getContentType.\r
+     */\r
+    NodeContext createNodeContext(ReadGraph graph, Object content) throws DatabaseException;\r
+    \r
+    /**\r
+     * Returns the expected Java type of the content.\r
+     */\r
+    Class<?> getContentType();\r
+    \r
+    /**\r
+     * Tests if this node type inherits (or is equal to) given node type.\r
+     */\r
+    boolean inherits(ReadGraph graph, NodeType superType) throws DatabaseException;\r
+\r
+    Collection<NodeType> getSuper(ReadGraph g) throws DatabaseException;\r
+\r
+    String toString(ReadGraph graph) throws DatabaseException; \r
+    \r
+    WorkbenchSelectionElement getWorkbenchSelectionElement(NodeContext context);\r
+}\r