Package cdc.impex.imports

Interface WorkbookImporter

All Superinterfaces:
SheetImporter
All Known Implementing Classes:
CheckedWorkbookImporter, VerboseWorkbookImporter
public interface WorkbookImporter extends SheetImporter
This interface adds workbook level notifications to SheetImporter.
Author:
Damien Carbonne

  • Field Details

  • Method Details

    • beginImport

      default void beginImport(String systemId, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)
      Invoked to notify the beginning of import.
      Parameters:
      systemId - The system if of the imported data.
      issuesHandler - The issues handler that should be used by the application to generate new issues.

    • endImport

      default void endImport(String systemId, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)
      Invoked to notify the end of import.
      Parameters:
      systemId - The system if of the imported data.
      issuesHandler - The issues handler that should be used by the application to generate new issues.

    • fromDelegates

      static WorkbookImporter fromDelegates(WorkbookImporter def, Function<String,SheetImporter> function)
      Creates a delegating workbook importer.

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

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

    • fromDelegates

      static WorkbookImporter fromDelegates(Function<String,SheetImporter> function)

    • fromDelegates

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

    • fromDelegates

      static WorkbookImporter fromDelegates(Map<String,SheetImporter> map)