Package cdc.impex.exports

Class CheckedSheetExporter

java.lang.Object
cdc.impex.exports.CheckedSheetExporter
All Implemented Interfaces:
SheetExporter
Direct Known Subclasses:
CheckedWorkbookExporter
public class CheckedSheetExporter extends Object implements SheetExporter
Implementation of SheetExporter that inserts checks.

It can be extended and used like this: 


 public class FooExporter extends CheckedSheetExporter {
     @Override
     public void beginSheetExport(SheetTemplate template,
                                  IssuesHandler<? super ExportIssue> issuesHandler) {
         super.beginSheetExport(template, issuesHandler);
         // Add your code here
     }

     &#64;Override
     public int getNumberOfRemainingRows() {
        checkStatus(ImpExStatus.SHEET);
        return ...;
     }

     &#64;Override
     public void exportRow(ExportRow row,
                           IssuesHandler<? super ExportIssue> issuesHandler) {
         super.exportRow(row, issuesHandler);
         // Add your code here
     }

     &#64;Override
     public void endSheetExport(SheetTemplate template,
                                IssuesHandler<? super ExportIssue> issuesHandler) {
         super.endSheetExport(template, issuesHandler);
         // Add your code here
     }
 }
Author:
Damien Carbonne

  • Field Details

  • Constructor Details

    • CheckedSheetExporter

      public CheckedSheetExporter()

  • Method Details

    • checkStatus

      protected void checkStatus(ImpExStatus expected)

    • beginSheetExport

      public void beginSheetExport(SheetTemplateInstance templateInstance, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)
      Description copied from interface: SheetExporter
      Invoked to begin a sheet exports.
      Specified by:
      beginSheetExport in interface SheetExporter
      Parameters:
      templateInstance - The sheet template instance associated to this extraction.
      issuesHandler - The issues handler that should be used by the application to generate new issues.

    • getNumberOfRemainingRows

      public int getNumberOfRemainingRows()
      Specified by:
      getNumberOfRemainingRows in interface SheetExporter
      Returns:
      The remaining number of rows to extract in current row. It can be an approximation when > 0.
      WARNING: This must be 0 when there are no more rows to export.
      WARNING: This must be a negative number when the number is unknown.

    • exportRow

      public void exportRow(ExportRow row, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)
      Description copied from interface: SheetExporter
      Invoked to export the current row in current sheet.
      Specified by:
      exportRow in interface SheetExporter
      Parameters:
      row - The row that will contain extracted data.
      issuesHandler - The issues handler that should be used by the application to generate new issues.

    • endSheetExport

      public void endSheetExport(SheetTemplateInstance templateInstance, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)
      Description copied from interface: SheetExporter
      Invoked to end a sheet export.
      Specified by:
      endSheetExport in interface SheetExporter
      Parameters:
      templateInstance - The sheet template instance associated to this extraction.
      issuesHandler - The issues handler that should be used by the application to generate new issues.