Package cdc.impex.imports

Interface SheetImporter

All Known Subinterfaces:

WorkbookImporter

All Known Implementing Classes:

BatchSheetImporter, CheckedSheetImporter, CheckedWorkbookImporter, VerboseSheetImporter, VerboseWorkbookImporter

public interface SheetImporter

Interface implemented by classes that can import data from memory to storage device.

[File] → Importer → [Memory] → SheetImporter → [Storage Device].

Typically, it will consist in executing actions and propagate them to a database.

An implementation can support one one several templates.
As Importer uses one WorkbookImporter, use, for example, WorkbookImporter.fromDelegates(WorkbookImporter, Function) or WorkbookImporter.fromDelegates(WorkbookImporter, Map) to compose several SheetImporters into one.

Author:

Damien Carbonne

Field Summary

Fields

Modifier and Type	Field	Description
static SheetImporter	QUIET_VOID
static SheetImporter	VERBOSE_VOID

Method Summary

Modifier and Type	Method	Description
void	beginSheetImport(String systemId, String sheetName, SheetTemplate template, cdc.issues.IssuesHandler<? super ImportIssue> issuesHandler)	Invoked to notify the beginning of the import of a sheet.
void	endSheetImport(String systemId, String sheetName, SheetTemplate template, cdc.issues.IssuesHandler<? super ImportIssue> issuesHandler)	Invoked to notify the end of the import of a sheet.
void	importRow(ImportRow row, cdc.issues.IssuesHandler<? super ImportIssue> issuesHandler)	Invoked to notify the import a row.

Field Detail

QUIET_VOID

static final SheetImporter QUIET_VOID

VERBOSE_VOID

static final SheetImporter VERBOSE_VOID

Method Detail

beginSheetImport

void beginSheetImport(String systemId,
                      String sheetName,
                      SheetTemplate template,
                      cdc.issues.IssuesHandler<? super ImportIssue> issuesHandler)

Invoked to notify the beginning of the import of a sheet.

Parameters:

systemId - The system if of the imported data.

sheetName - The sheet name.

template - The sheet template associated to this import.

issuesHandler - The issues handler that should be used by the application to generate new issues.

importRow

void importRow(ImportRow row,
               cdc.issues.IssuesHandler<? super ImportIssue> issuesHandler)

Invoked to notify the import a row.

Parameters:

row - The imported row.

issuesHandler - The issues handler that should be used by the application to generate new issues.

endSheetImport

void endSheetImport(String systemId,
                    String sheetName,
                    SheetTemplate template,
                    cdc.issues.IssuesHandler<? super ImportIssue> issuesHandler)

Invoked to notify the end of the import of a sheet.

Parameters:

systemId - The system if of the imported data.

sheetName - The sheet name.

template - The sheet template associated to this import.

issuesHandler - The issues handler that should be used by the application to generate new issues.