Package cdc.impex.api.exports

Interface WorkbookExporter

All Superinterfaces:

SheetExporter

All Known Implementing Classes:

CheckedWorkbookExporter, VerboseWorkbookExporter

public interface WorkbookExporter
extends SheetExporter

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

Author:

Damien Carbonne

Field Summary

Fields

Modifier and Type	Field	Description
static WorkbookExporter	QUIET_VOID
static WorkbookExporter	VERBOSE_VOID

Method Summary

Modifier and Type	Method	Description
void	beginExtraction(cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)	Invoked to begin an extraction.
void	endExtraction(cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)	Invoked to end an extraction.
static WorkbookExporter	fromDelegates(WorkbookExporter def, Function<String,SheetExporter> function)
static WorkbookExporter	fromDelegates(WorkbookExporter def, Map<String,SheetExporter> map)	Creates a delegating handler.
static WorkbookExporter	fromDelegates(Function<String,SheetExporter> function)
static WorkbookExporter	fromDelegates(Map<String,SheetExporter> map)

Methods inherited from interface cdc.impex.api.exports.SheetExporter

beginSheetExtraction, endSheetExtraction, extractRow, getNumberOfRemainingRows, hasMore

Field Detail

QUIET_VOID

static final WorkbookExporter QUIET_VOID

VERBOSE_VOID

static final WorkbookExporter VERBOSE_VOID

Method Detail

beginExtraction

void beginExtraction(cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)

Invoked to begin an extraction.

Parameters:

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

endExtraction

void endExtraction(cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)

Invoked to end an extraction.

Parameters:

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

fromDelegates

static WorkbookExporter fromDelegates(WorkbookExporter def,
                                      Function<String,SheetExporter> function)

fromDelegates

static WorkbookExporter fromDelegates(Function<String,SheetExporter> function)

fromDelegates

static WorkbookExporter fromDelegates(WorkbookExporter def,
                                      Map<String,SheetExporter> map)

Creates a delegating handler.

Parameters:

def - The default sheet importer.
It could be QUIET_VOID, VERBOSE_VOID, or any other valid SheetImporter.

map - The map from template names to the associated importers.

Returns:

A new SheetImporter that delegates import if possible, or use the default handler otherwise.

fromDelegates

static WorkbookExporter fromDelegates(Map<String,SheetExporter> map)