Package cdc.impex.api.exports

Interface SheetExporter

All Known Subinterfaces:

WorkbookExporter

All Known Implementing Classes:

CheckedSheetExporter, CheckedWorkbookExporter, VerboseSheetExporter, VerboseWorkbookExporter

public interface SheetExporter

Interface implemented by classes that can extract sheet data to export.

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
void	beginSheetExtraction(SheetTemplate template, cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)	Invoked to begin a sheet extraction.
void	endSheetExtraction(SheetTemplate template, cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)	Invoked to end a sheet extraction.
void	extractRow(ExportRow row, cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)	Invoked to extract 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

beginSheetExtraction

void beginSheetExtraction(SheetTemplate template,
                          cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)

Invoked to begin a sheet extraction.

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.

extractRow

void extractRow(ExportRow row,
                cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)

Invoked to extract 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.

endSheetExtraction

void endSheetExtraction(SheetTemplate template,
                        cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)

Invoked to end a sheet extraction.

Parameters:

template - The sheet template associated to this extraction.

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