Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.ui / src / org / simantics / ui / workbench / IResourceEditorInput2.java

diff --git a/bundles/org.simantics.ui/src/org/simantics/ui/workbench/IResourceEditorInput2.java b/bundles/org.simantics.ui/src/org/simantics/ui/workbench/IResourceEditorInput2.java
new file mode 100644 (file)
index 0000000..46829c9
--- /dev/null
+++ b/bundles/org.simantics.ui/src/org/simantics/ui/workbench/IResourceEditorInput2.java
@@ -0,0 +1,68 @@
+/*******************************************************************************\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.ui.workbench;\r
+\r
+import org.eclipse.ui.IEditorInput;\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.Resource;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.db.layer0.variable.Variable;\r
+\r
+/**\r
+ * @author Tuukka Lehtonen\r
+ * \r
+ * @see ResourceEditorInput2\r
+ */\r
+public interface IResourceEditorInput2 extends IEditorInput, IResourceEditorInput {\r
+\r
+    /**\r
+        * This is a base URI, not a model URI but the name of the method cannot be\r
+        * changed now. If {@link #getRVI()} returns <code>null</code>, this URI\r
+        * should be used as such to get a {@link Variable} view of the input.\r
+        * \r
+        * @return URI of the model the input is related to or <code>null</code> if\r
+        *         no model is available\r
+        */\r
+//    String getModelURI();\r
+\r
+    Resource getModel(ReadGraph graph);\r
+    \r
+    /**\r
+        * @return a {@link Variable} Relative Variable Identifier (RVI). May be an\r
+        *         empty string or <code>null</code> if {@link #getModelURI()}\r
+        *         should be interpreted as the absolute {@link Variable} URI of the\r
+        *         input.\r
+        */\r
+    String getRVI();\r
+\r
+    /**\r
+     * Adapt this editor input into a {@link Variable} outside of a database\r
+     * transaction.\r
+     * \r
+     * @return\r
+     * @throws DatabaseException if variable adaption fails\r
+     * @since 1.6\r
+     */\r
+    Variable getVariable() throws DatabaseException;\r
+\r
+    /**\r
+     * Adapt this editor input into a {@link Variable} within a database\r
+     * transaction.\r
+     * \r
+     * @param graph\r
+     * @return\r
+     * @throws DatabaseException if variable adaption fails\r
+     * @since 1.6\r
+     */\r
+    Variable getVariable(ReadGraph graph) throws DatabaseException;\r
+\r
+}\r