Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.export.core / src / org / simantics / export / core / intf / ExportClass.java

diff --git a/bundles/org.simantics.export.core/src/org/simantics/export/core/intf/ExportClass.java b/bundles/org.simantics.export.core/src/org/simantics/export/core/intf/ExportClass.java
new file mode 100644 (file)
index 0000000..29cee93
--- /dev/null
+++ b/bundles/org.simantics.export.core/src/org/simantics/export/core/intf/ExportClass.java
@@ -0,0 +1,89 @@
+package org.simantics.export.core.intf;\r
+\r
+import java.util.Collection;\r
+import java.util.List;\r
+\r
+import org.eclipse.core.runtime.IProgressMonitor;\r
+import org.osgi.service.prefs.Preferences;\r
+import org.simantics.databoard.binding.mutable.Variant;\r
+import org.simantics.databoard.type.RecordType;\r
+import org.simantics.export.core.ExportContext;\r
+import org.simantics.export.core.error.ExportException;\r
+import org.simantics.export.core.manager.Content;\r
+import org.simantics.utils.datastructures.MapList;\r
+\r
+public interface ExportClass {\r
+       \r
+       /**\r
+        * Get extension specific options.\r
+        * \r
+        * @param ctx\r
+        * @param contentUris\r
+        * @return a record type describing options \r
+        */\r
+       RecordType options( ExportContext ctx, Collection<String> contentUris ) throws ExportException;\r
+       \r
+       /**\r
+        * Validate that the content can be exported. If not, an exception is thrown. \r
+        * \r
+        * @param contentUri\r
+        * @param writer\r
+        * @param context\r
+        * @param monitor\r
+        * @param options\r
+        * @return list of errors  \r
+        */\r
+       List<String> validate(\r
+                       String contentUri, \r
+                       ExportContext context,\r
+                       Variant options);\r
+       \r
+       /**\r
+        * Write format specific content to a content writer. \r
+        * \r
+        * @param contentUris a list of uris\r
+        * @param writer a writer object that is created with format extension\r
+        * @param ctx export context\r
+        * @param options all export options in a variant\r
+        * @param monitor\r
+        * @param attachmentMap (optional) attachments \r
+        * @throws ExportException\r
+        */\r
+       void export(\r
+                       List<Content> contents, \r
+                       Object writer, \r
+                       ExportContext ctx,\r
+                       Variant options,\r
+                       IProgressMonitor monitor, \r
+                       MapList<Content, Content> attachmentMap\r
+                       ) throws ExportException;\r
+\r
+       /**\r
+        * Fill the options object with default values.\r
+        * \r
+        * @param ctx \r
+        * @param options\r
+        */\r
+       void fillDefaultPrefs( ExportContext ctx, Variant options ) throws ExportException;\r
+\r
+       /**\r
+        * Save export options to preferences node(s).\r
+        * \r
+        * @param options\r
+        * @param contentScopePrefs\r
+        * @param workspaceScopePrefs\r
+        * @throws ExportException\r
+        */\r
+       void savePref( Variant options, Preferences contentScopePrefs, Preferences workspaceScopePrefs ) throws ExportException;\r
+       \r
+       /**\r
+        * Load export options from preferences node(s).\r
+        * \r
+        * @param options\r
+        * @param contentScopeNode\r
+        * @param workspaceScopePrefs\r
+        * @throws ExportException\r
+        */\r
+       void loadPref( Variant options, Preferences contentScopeNode, Preferences workspaceScopePrefs ) throws ExportException;\r
+       \r
+}\r