Package cdc.impex.exports

Interface WorkbookExporter

All Superinterfaces:
SheetExporter
All Known Implementing Classes:
CheckedWorkbookExporter, VerboseWorkbookExporter
public interface WorkbookExporter extends SheetExporter
Interface implemented by classes that can extract workbook data to export.
Author:
Damien Carbonne

  • Field Details

  • Method Details

    • beginExport

      default void beginExport(cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)
      Invoked to notify the beginning of export.
      Parameters:
      issuesHandler - The issues handler that should be used by the application to generate new issues.

    • endExport

      default void endExport(cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)
      Invoked to notify the end of export.
      Parameters:
      issuesHandler - The issues handler that should be used by the application to generate new issues.

    • fromDelegates

      static WorkbookExporter fromDelegates(WorkbookExporter def, Function<String,SheetExporter> function)
      Creates a delegating workbook exporter.

      When the export of a sheet starts, an appropriate sheet exporter is selected, if possible, among delegates. If no appropriate sheet exporter is found, the default workbook exporter is used. The default will usually ignore things.

      Parameters:
      def - The default workbook exporter.
      It can be QUIET_VOID, VERBOSE_VOID, or any other valid WorkbookExporter.
      function - The function that maps template names to the associated sheet exporters.
      Returns:
      A new WorkbookExporter that delegates export if possible, or use the default workbook exporter otherwise.

    • fromDelegates

      static WorkbookExporter fromDelegates(Function<String,SheetExporter> function)

    • fromDelegates

      static WorkbookExporter fromDelegates(WorkbookExporter def, Map<String,SheetExporter> map)
      Creates a delegating workbook exporter.
      Parameters:
      def - The default workbook exporter.
      It can be QUIET_VOID, VERBOSE_VOID, or any other valid WorkbookExporter.
      map - The map from template names to the associated sheet exporters.
      Returns:
      A new WorkbookExporter that delegates export if possible, or use the default workbook exporter otherwise.

    • fromDelegates

      static WorkbookExporter fromDelegates(Map<String,SheetExporter> map)