org.jberet.support.io

Class ExcelUserModelItemWriter

java.lang.Object

org.jberet.support.io.ItemReaderWriterBase

org.jberet.support.io.JsonItemReaderWriterBase

org.jberet.support.io.ExcelItemReaderWriterBase

org.jberet.support.io.ExcelUserModelItemWriter

All Implemented Interfaces:

javax.batch.api.chunk.ItemWriter

Direct Known Subclasses:

ExcelStreamingItemWriter

@Named
 @Dependent
public class ExcelUserModelItemWriter
extends ExcelItemReaderWriterBase
implements javax.batch.api.chunk.ItemWriter

An implementation of javax.batch.api.chunk.ItemWriter for Excel files. This implementation is currently based on Apache POI user model API, and in-memory content generation. For large data set that may cause memory issue, consider using ExcelStreamingItemWriter.

Since:

1.1.0

See Also:

ExcelUserModelItemReader, ExcelItemReaderWriterBase, ExcelStreamingItemWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected OutputStream	outputStream
protected Integer	templateHeaderRow The row number (0-based) of the header in the template sheet.
protected String	templateResource The resource of an existing Excel file or template file to be used as a base for generating output Excel.
protected int	templateSheetIndex The sheet index (0-based) in the template file to be used for generating output Excel.
protected String	templateSheetName The sheet name in the template file to be used for generating output Excel.
protected String	writeMode Valid writeMode for this writer class is CsvProperties.OVERWRITE and CsvProperties.FAIL_IF_EXISTS.

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
ExcelUserModelItemWriter()

Method Summary

Modifier and Type	Method and Description
Serializable	checkpointInfo()
void	close()
protected void	createCell(org.apache.poi.ss.usermodel.Row row, int columnIndex, Object val)
protected org.apache.poi.ss.usermodel.Workbook	createWorkbook(InputStream templateInputStream) Creates the workbook for this writer.
void	open(Serializable checkpoint)
void	writeItems(List<Object> items)

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

writeMode

@Inject
protected String writeMode

Valid writeMode for this writer class is CsvProperties.OVERWRITE and CsvProperties.FAIL_IF_EXISTS.

templateResource

@Inject
protected String templateResource

The resource of an existing Excel file or template file to be used as a base for generating output Excel. Its format is similar to ItemReaderWriterBase.resource.

templateSheetName

@Inject
protected String templateSheetName

The sheet name in the template file to be used for generating output Excel. If templateResource is specified but this property is not specified, templateSheetIndex is used instead.

templateSheetIndex

@Inject
protected int templateSheetIndex

The sheet index (0-based) in the template file to be used for generating output Excel.

templateHeaderRow

@Inject
protected Integer templateHeaderRow

The row number (0-based) of the header in the template sheet. If ExcelItemReaderWriterBase.header property is provided in job xml file, then this property is ignored. Otherwise, it is used to retrieve header values.

outputStream

protected OutputStream outputStream

Constructor Detail

ExcelUserModelItemWriter

public ExcelUserModelItemWriter()

Method Detail

open

public void open(Serializable checkpoint)
          throws Exception

Specified by:

open in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception

writeItems

public void writeItems(List<Object> items)
                throws Exception

Specified by:

writeItems in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception

checkpointInfo

public Serializable checkpointInfo()
                            throws Exception

Specified by:

checkpointInfo in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface javax.batch.api.chunk.ItemWriter

Throws:

Exception

createWorkbook

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

Creates the workbook for this writer.

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

createCell

protected void createCell(org.apache.poi.ss.usermodel.Row row,
                          int columnIndex,
                          Object val)
                   throws Exception

Throws:

Exception