bundles/org.simantics.export.core/src/org/simantics/export/core/intf/Exporter.java

   1 package org.simantics.export.core.intf;\r
   2 \r
   3 import org.simantics.export.core.error.ExportException;\r
   4 \r
   5 /**\r
   6  * Exporter exports content for one specific format.\r
   7  *\r
   8  * @author toni.kalajainen@semantum.fi\r
   9  */\r
  10 public interface Exporter {\r
  11         \r
  12         /**\r
  13          * Identifier for the file format, eg. "pdf", "tg", "csv".\r
  14          * @return\r
  15          */\r
  16         String formatId();\r
  17         \r
  18         /**\r
  19          * The identifier to the content type, that this definition can export.\r
  20          * @return \r
  21          */\r
  22         String contentTypeId();\r
  23         \r
  24         /**\r
  25          * Code that exports the content into format specific writer. \r
  26          * @return\r
  27          * @throws ExportException \r
  28          */\r
  29         ExportClass exportAction() throws ExportException;\r
  30         \r
  31         /**\r
  32          * Priority of this exporter in comparison to other exporters for the \r
  33          * content. The smaller the number the higher the priority. \r
  34          * \r
  35          * @return priority \r
  36          */\r
  37         int getExportPriority();\r
  38         \r
  39 }\r