org.jberet.support.io

Class ExcelStreamingItemWriter

java.lang.Object

org.jberet.support.io.ItemReaderWriterBase

org.jberet.support.io.JsonItemReaderWriterBase

org.jberet.support.io.ExcelItemReaderWriterBase

org.jberet.support.io.ExcelUserModelItemWriter

org.jberet.support.io.ExcelStreamingItemWriter

All Implemented Interfaces:

javax.batch.api.chunk.ItemWriter

@Named
 @Dependent
public class ExcelStreamingItemWriter
extends ExcelUserModelItemWriter

An implementation of javax.batch.api.chunk.ItemWriter for Excel 2007 OOXML (.xlsx) file format. This implementation is currently based on Apache POI SXSSF (buffered streaming) API, and is suitable for handling large data set. Note that different versions of Excel have different limits for row number and column numbers. As of Excel 2010, the row number limit is 1048576. For more details, see http://office.microsoft.com/en-us/excel-help/excel-specifications-and-limits-HP010342495.aspx

Since:

1.1.0

See Also:

ExcelUserModelItemWriter, ExcelItemReaderWriterBase

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	compressTempFiles Whether to compress the temp files in the course of generating Excel file, defaults to false.

Fields inherited from class org.jberet.support.io.ExcelUserModelItemWriter

outputStream, templateHeaderRow, templateResource, templateSheetIndex, templateSheetName, writeMode

Fields inherited from class org.jberet.support.io.ExcelItemReaderWriterBase

beanType, currentRowNum, header, sheet, sheetName, workbook

Fields inherited from class org.jberet.support.io.JsonItemReaderWriterBase

customDataTypeModules, customDeserializers, customSerializers, deserializationFeatures, jsonFactory, jsonFactoryFeatures, jsonFactoryLookup, mapperFeatures, objectMapper, serializationFeatures

Fields inherited from class org.jberet.support.io.ItemReaderWriterBase

NEW_LINE, resource, skipBeanValidation

Constructor Summary

Constructors

Constructor and Description
ExcelStreamingItemWriter()

Method Summary

Modifier and Type	Method and Description
protected org.apache.poi.ss.usermodel.Workbook	createWorkbook(InputStream templateInputStream) Creates the workbook for this writer.

Methods inherited from class org.jberet.support.io.ExcelUserModelItemWriter

checkpointInfo, close, createCell, open, writeItems

Methods inherited from class org.jberet.support.io.ExcelItemReaderWriterBase

getCellStringValues

Methods inherited from class org.jberet.support.io.JsonItemReaderWriterBase

initJsonFactory, initJsonFactoryAndObjectMapper, registerModule

Methods inherited from class org.jberet.support.io.ItemReaderWriterBase

getInputStream, getOutputStream, getValidator, validate

Methods inherited from class java.lang.Object

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

Field Detail

compressTempFiles

@Inject
protected Boolean compressTempFiles

Whether to compress the temp files in the course of generating Excel file, defaults to false.

Constructor Detail

ExcelStreamingItemWriter

public ExcelStreamingItemWriter()

Method Detail

createWorkbook

protected org.apache.poi.ss.usermodel.Workbook createWorkbook(InputStream templateInputStream)
                                                       throws IOException,
                                                              org.apache.poi.openxml4j.exceptions.InvalidFormatException

Description copied from class: ExcelUserModelItemWriter

Creates the workbook for this writer.

Overrides:

createWorkbook in class ExcelUserModelItemWriter

Parameters:

templateInputStream - java.io.InputStream for the template excel file, if any

Returns:

the template workbook if a template is specified; otherwise null

Throws:

IOException

org.apache.poi.openxml4j.exceptions.InvalidFormatException