Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.export.core/src/org/simantics/export/core/intf/Exporter.java b/bundles/org.simantics.export.core/src/org/simantics/export/core/intf/Exporter.java
new file mode 100644 (file)
index 0000000..83b9b97
--- /dev/null
+++ b/bundles/org.simantics.export.core/src/org/simantics/export/core/intf/Exporter.java
@@ -0,0 +1,39 @@
+package org.simantics.export.core.intf;\r
+\r
+import org.simantics.export.core.error.ExportException;\r
+\r
+/**\r
+ * Exporter exports content for one specific format.\r
+ *\r
+ * @author toni.kalajainen@semantum.fi\r
+ */\r
+public interface Exporter {\r
+       \r
+       /**\r
+        * Identifier for the file format, eg. "pdf", "tg", "csv".\r
+        * @return\r
+        */\r
+       String formatId();\r
+       \r
+       /**\r
+        * The identifier to the content type, that this definition can export.\r
+        * @return \r
+        */\r
+       String contentTypeId();\r
+       \r
+       /**\r
+        * Code that exports the content into format specific writer. \r
+        * @return\r
+        * @throws ExportException \r
+        */\r
+       ExportClass exportAction() throws ExportException;\r
+       \r
+       /**\r
+        * Priority of this exporter in comparison to other exporters for the \r
+        * content. The smaller the number the higher the priority. \r
+        * \r
+        * @return priority \r
+        */\r
+       int getExportPriority();\r
+       \r
+}\r