Package cdc.impex.exports

Interface SheetExporter

All Known Subinterfaces:

WorkbookExporter

All Known Implementing Classes:

CheckedSheetExporter, CheckedWorkbookExporter, VerboseSheetExporter, VerboseWorkbookExporter

public interface SheetExporter

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

[Storage Device] → SheetExporter → [Memory] → Exporter → [File/Stream].

A SheetExporter can export data corresponding to different (at least one) SheetTemplates.

Author:

Damien Carbonne

Field Summary

Fields

Modifier and Type	Field	Description
static SheetExporter	QUIET_VOID
static SheetExporter	VERBOSE_VOID

Method Summary

Modifier and Type	Method	Description
default void	beginSheetExport(SheetTemplate template, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)	Invoked to begin a sheet exports.
default void	endSheetExport(SheetTemplate template, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)	Invoked to end a sheet export.
void	exportRow(ExportRow row, cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)	Invoked to export the current row in current sheet.
int	getNumberOfRemainingRows()
default boolean	hasMore()

Field Detail

QUIET_VOID

static final SheetExporter QUIET_VOID

VERBOSE_VOID

static final SheetExporter VERBOSE_VOID

Method Detail

beginSheetExport

default void beginSheetExport(SheetTemplate template,
                              cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)

Invoked to begin a sheet exports.

Parameters:

template - The sheet template associated to this extraction.

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

getNumberOfRemainingRows

int getNumberOfRemainingRows()

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.

hasMore

default boolean hasMore()

Returns:

true if there are no more rows to extract in current sheet.

exportRow

void exportRow(ExportRow row,
               cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)

Invoked to export the current row in current sheet.

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

default void endSheetExport(SheetTemplate template,
                            cdc.issues.IssuesHandler<cdc.issues.Issue> issuesHandler)

Invoked to end a sheet export.

Parameters:

template - The sheet template associated to this extraction.

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