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

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