Package cdc.impex.exports

Interface StreamExporter

All Superinterfaces:

AutoCloseable, Closeable, Flushable

public interface StreamExporter
extends Flushable, Closeable

Interface implemented by classes that can be used to export data.

This is a low level API that should be used like this:

 beginExport(file/stream);
 foreach (sheet):
    beginSheet(sheet.template);
    foreach (row):
       beginRow();
       foreach(column):
          setData(column, data);
       endRow();
    endSheet();
 endExport();
 

Author:

Damien Carbonne

Method Summary

Modifier and Type	Method	Description
void	addReadme(List<SheetTemplateInstance> templateInstances)
void	addRow(ExportRow row)
void	beginExport(File file)	Must be invoked at beginning of export to a File.
void	beginExport(OutputStream out, ImpExFormat format)	Must be invoked at beginning of export to an OutputStream.
void	beginSheet(SheetTemplateInstance templateInstance, String sheetName, long numberOfRows)	Must be invoked at the beginning of a sheet export.
void	endExport()	Must be invoked at end of export.
void	endSheet()	Must be invoked at the end of writing a sheet.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.io.Flushable

flush

Method Details

beginExport

void beginExport(File file)
          throws IOException

Must be invoked at beginning of export to a File.

The used Charset is the one defined in WorkbookWriterFeatures associated to the ImpExFactoryFeatures.

Parameters:

file - The target file.

Throws:

IOException - When a IO error occurs.

IllegalArgumentException - When file is null.

beginExport

void beginExport(OutputStream out,
 ImpExFormat format)
          throws IOException

Must be invoked at beginning of export to an OutputStream.

The used Charset is the one defined in WorkbookWriterFeatures associated to the ImpExFactoryFeatures.

Parameters:

out - The output stream.

format - The format.

Throws:

IOException - When a IO error occurs.

IllegalArgumentException - When out or format is null, or when format is not supported.

addReadme

void addReadme(List<SheetTemplateInstance> templateInstances)
        throws IOException

Throws:

IOException

beginSheet

void beginSheet(SheetTemplateInstance templateInstance,
 String sheetName,
 long numberOfRows)
         throws IOException

Must be invoked at the beginning of a sheet export.

Using several times the same template in a workbook must be supported.

Parameters:

templateInstance - The sheet template instance used for that sheet.

sheetName - The sheet name.

numberOfRows - The number of rows to export in this sheet, or -1L if unknown.

Throws:

IOException - When a IO error occurs.

addRow

void addRow(ExportRow row)
     throws IOException

Throws:

IOException

endSheet

void endSheet()
       throws IOException

Must be invoked at the end of writing a sheet.

Throws:

IOException - When a IO error occurs.

endExport

void endExport()
        throws IOException

Must be invoked at end of export.

WARNING This will not close this export driver.

Throws:

IOException - When a IO error occurs.