Package org.springframework.batch.extensions.excel.streaming

Class StreamingXlsxItemReader<T>

java.lang.Object

org.springframework.batch.item.ItemStreamSupport

org.springframework.batch.item.support.AbstractItemStreamItemReader<T>

org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader<T>

org.springframework.batch.extensions.excel.AbstractExcelItemReader<T>

org.springframework.batch.extensions.excel.streaming.StreamingXlsxItemReader<T>

Type Parameters:

T - the type

All Implemented Interfaces:

org.springframework.batch.item.file.ResourceAwareItemReaderItemStream<T>, org.springframework.batch.item.ItemReader<T>, org.springframework.batch.item.ItemStream, org.springframework.batch.item.ItemStreamReader<T>, org.springframework.beans.factory.InitializingBean

public class StreamingXlsxItemReader<T>
extends AbstractExcelItemReader<T>

Simple streaming reader without Apache POI.

Since:

0.1.0

Author:

Marten Deinum

Field Summary

Fields inherited from class org.springframework.batch.extensions.excel.AbstractExcelItemReader

logger

Constructor Summary

Constructors

Constructor	Description
StreamingXlsxItemReader()

Method Summary

Modifier and Type	Method	Description
protected void	doClose()
protected int	getNumberOfSheets()	The number of sheets in the underlying workbook.
protected Sheet	getSheet(int sheet)	Get the sheet based on the given sheet index.
protected void	openExcelFile(org.springframework.core.io.Resource resource, String password)	Opens the excel file and reads the file and sheet metadata.

Methods inherited from class org.springframework.batch.extensions.excel.AbstractExcelItemReader

afterPropertiesSet, doOpen, doRead, jumpToItem, read, setEndAfterBlankLines, setLinesToSkip, setPassword, setResource, setRowMapper, setRowSetFactory, setSkippedRowsCallback, setStrict

Methods inherited from class org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader

close, getCurrentItemCount, isSaveState, open, setCurrentItemCount, setMaxItemCount, setSaveState, update

Methods inherited from class org.springframework.batch.item.ItemStreamSupport

getExecutionContextKey, setExecutionContextName, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.batch.item.ItemStream

close, open, update

Constructor Details

StreamingXlsxItemReader

public StreamingXlsxItemReader()

Method Details

getSheet

protected Sheet getSheet(int sheet)

Description copied from class: AbstractExcelItemReader

Get the sheet based on the given sheet index.

Specified by:

getSheet in class AbstractExcelItemReader<T>

Parameters:

sheet - the sheet index

Returns:

the sheet or null when no sheet available.

getNumberOfSheets

protected int getNumberOfSheets()

Description copied from class: AbstractExcelItemReader

The number of sheets in the underlying workbook.

Specified by:

getNumberOfSheets in class AbstractExcelItemReader<T>

Returns:

the number of sheets.

openExcelFile

protected void openExcelFile(org.springframework.core.io.Resource resource,
 String password)
                      throws Exception

Description copied from class: AbstractExcelItemReader

Opens the excel file and reads the file and sheet metadata. Uses a Resource to read the sheets, this file can optionally be password protected.

Specified by:

openExcelFile in class AbstractExcelItemReader<T>

Parameters:

resource - Resource pointing to the Excel file to read

password - optional password

Throws:

Exception - when the Excel sheet cannot be accessed

doClose

protected void doClose()
                throws Exception

Overrides:

doClose in class AbstractExcelItemReader<T>

Throws:

Exception