Package cdc.impex.api.exports

Class CheckedSheetExporter

java.lang.Object

cdc.impex.api.exports.CheckedSheetExporter

All Implemented Interfaces:

SheetExporter

Direct Known Subclasses:

CheckedWorkbookExporter

public class CheckedSheetExporter
extends Object
implements SheetExporter

Field Summary

Fields

Modifier and Type	Field	Description
protected ImpExStatus	status

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

QUIET_VOID, VERBOSE_VOID

Constructor Summary

Constructors

Constructor	Description
CheckedSheetExporter()

Method Summary

Modifier and Type	Method	Description
void	beginSheetExtraction(SheetTemplate template, cdc.issues.api.IssuesHandler<? super ExportIssue> issuesHandler)	Invoked to begin a sheet extraction.
protected void	checkStatus(ImpExStatus expected)
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()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

hasMore

Field Detail

status

protected ImpExStatus status

Constructor Detail

CheckedSheetExporter

public CheckedSheetExporter()

Method Detail

checkStatus

protected void checkStatus(ImpExStatus expected)

beginSheetExtraction

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

Description copied from interface: SheetExporter

Invoked to begin a sheet extraction.

Specified by:

beginSheetExtraction in interface SheetExporter

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

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.

extractRow

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

Description copied from interface: SheetExporter

Invoked to extract the current row in current sheet.

Specified by:

extractRow 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.

endSheetExtraction

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

Description copied from interface: SheetExporter

Invoked to end a sheet extraction.

Specified by:

endSheetExtraction in interface SheetExporter

Parameters:

template - The sheet template associated to this extraction.

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