org.jberet.support.io

Class ExcelEventItemReader

java.lang.Object

org.jberet.support.io.ItemReaderWriterBase

org.jberet.support.io.JsonItemReaderWriterBase

org.jberet.support.io.ExcelItemReaderWriterBase

org.jberet.support.io.ExcelUserModelItemReader

org.jberet.support.io.ExcelEventItemReader

All Implemented Interfaces:

javax.batch.api.chunk.ItemReader

@Named
 @Dependent
public class ExcelEventItemReader
extends ExcelUserModelItemReader
implements javax.batch.api.chunk.ItemReader

An implementation of javax.batch.api.chunk.ItemReader for reading binary Excel files (.xls) based on Apache POI event model API. Compared to ExcelUserModelItemReader, this reader implementation has smaller memory footprint and is suitable for reading large binary excel files.

Since:

1.1.0

See Also:

ExcelUserModelItemReader, ExcelStreamingItemReader, ExcelItemReaderWriterBase

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_WORKSHEET_ROWS Maximum worksheet row numbers for Excel 2003: 65,536 (2 ** 16) http://office.microsoft.com/en-us/excel-help/excel-specifications-and-limits-HP005199291.aspx
protected int	queueCapacity the capacity of the queue used by org.apache.poi.hssf.eventusermodel.HSSFListener to hold pre-fetched data rows.

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

end, formulaEvaluator, headerMapping, headerRow, inputStream, minColumnCount, rowIterator, sheetIndex, start

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

Method Summary

Modifier and Type	Method and Description
Serializable	checkpointInfo()
void	close()
protected void	initWorkbookAndSheet(int startRowNumber)
Object	readItem()

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

getCellValue, open

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

Methods inherited from interface javax.batch.api.chunk.ItemReader

open

Field Detail

MAX_WORKSHEET_ROWS

protected static final int MAX_WORKSHEET_ROWS

Maximum worksheet row numbers for Excel 2003: 65,536 (2 ** 16) http://office.microsoft.com/en-us/excel-help/excel-specifications-and-limits-HP005199291.aspx

See Also:

Constant Field Values

queueCapacity

@Inject
protected int queueCapacity

the capacity of the queue used by org.apache.poi.hssf.eventusermodel.HSSFListener to hold pre-fetched data rows. Optional property and defaults to MAX_WORKSHEET_ROWS (65536).

Constructor Detail

ExcelEventItemReader

public ExcelEventItemReader()

Method Detail

readItem

public Object readItem()
                throws Exception

Specified by:

readItem in interface javax.batch.api.chunk.ItemReader

Overrides:

readItem in class ExcelUserModelItemReader

Throws:

Exception

checkpointInfo

public Serializable checkpointInfo()
                            throws Exception

Specified by:

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

Overrides:

checkpointInfo in class ExcelUserModelItemReader

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

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

Overrides:

close in class ExcelUserModelItemReader

Throws:

Exception

initWorkbookAndSheet

protected void initWorkbookAndSheet(int startRowNumber)
                             throws Exception

Overrides:

initWorkbookAndSheet in class ExcelUserModelItemReader

Throws:

Exception