Package cdc.impex.exports

Interface Exporter

All Known Implementing Classes:
VerboseExporter
public interface Exporter
Interface implemented by classes that can export data to a file or stream.
Author:
Damien Carbonne

  • Method Details

    • exportData

      void exportData(File file, List<SheetTemplateInstance> templateInstances, WorkbookExporter workbookExporter, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler, cdc.util.events.ProgressController controller) throws IOException
      Export data to a file.
      Parameters:
      file - The file to generate.
      templateInstances - The list of template instances for which sheets must be generated.
      workbookExporter - The workbook exporter to be used to extract data to export.
      issuesHandler - The issues handler.
      controller - The controller.
      Throws:
      IOException - When an IO error occurs.
      IllegalArgumentException - When any input parameter is null.

    • exportData

      void exportData(OutputStream out, String systemId, ImpExFormat format, List<SheetTemplateInstance> templateInstances, WorkbookExporter workbookExporter, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler, cdc.util.events.ProgressController controller) throws IOException
      Export data to an output stream using a format.
      Parameters:
      out - The output stream.
      systemId - The system id.
      format - The format.
      templateInstances - The list of template instances for which sheets must be generated.
      workbookExporter - The workbook exporter to be used to extract data to export.
      issuesHandler - The issues handler.
      controller - The controller.
      Throws:
      IOException - When an IO error occurs.
      IllegalArgumentException - When any input parameter (except systemId) is null.

    • exportData

      static void exportData(File file, List<String> templateNames, ImpExCatalog catalog, Function<SheetTemplate,SheetTemplateInstance> instancier, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler, cdc.util.events.ProgressController controller, ImpExFactoryFeatures features) throws IOException
      Exports data to a file using an ImpExCatalog.
      Parameters:
      file - The file to generate.
      templateNames - The list of template names.
      catalog - The catalog.
      instancier - The function that converts each template to a template instance.
      issuesHandler - The issues handler.
      controller - The controller.
      features - The features.
      Throws:
      IOException - When an IO error occurs.

    • exportData

      static void exportData(File file, List<String> templateNames, ImpExCatalog catalog, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler, cdc.util.events.ProgressController controller, ImpExFactoryFeatures features) throws IOException
      Exports data to a file using an ImpExCatalog.

      WARNING: this must be used when all template headers contain only names.

      Parameters:
      file - The file to generate.
      templateNames - The list of template names.
      catalog - The catalog.
      issuesHandler - The issues handler.
      controller - The controller.
      features - The features.
      Throws:
      IOException - When an IO error occurs.

    • exportData

      static void exportData(OutputStream out, String systemId, ImpExFormat format, List<String> templateNames, ImpExCatalog catalog, Function<SheetTemplate,SheetTemplateInstance> instancier, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler, cdc.util.events.ProgressController controller, ImpExFactoryFeatures features) throws IOException
      Exports data to a stream using an ImpExCatalog.
      Parameters:
      out - The output stream.
      systemId - The system id.
      format - The format.
      templateNames - The list of template names.
      catalog - The catalog.
      instancier - The function that converts each template to a template instance.
      issuesHandler - The issues handler.
      controller - The controller.
      features - The features.
      Throws:
      IOException - When an IO error occurs.

    • exportData

      static void exportData(OutputStream out, String systemId, ImpExFormat format, List<String> templateNames, ImpExCatalog catalog, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler, cdc.util.events.ProgressController controller, ImpExFactoryFeatures features) throws IOException
      Exports data to a stream using an ImpExCatalog.

      WARNING: this must be used when all template headers contain only names.

      Parameters:
      out - The output stream.
      systemId - The system id.
      format - The format.
      templateNames - The list of template names.
      catalog - The catalog.
      issuesHandler - The issues handler.
      controller - The controller.
      features - The features.
      Throws:
      IOException - When an IO error occurs.