A B C D E G H I J L M N O P R S

A

AbstractExcelItemReader<T> - Class in org.springframework.batch.item.excel

ItemReader implementation to read an Excel file.

AbstractExcelItemReader() - Constructor for class org.springframework.batch.item.excel.AbstractExcelItemReader

afterPropertiesSet() - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

afterPropertiesSet() - Method in class org.springframework.batch.item.excel.mapping.BeanWrapperRowMapper

Check that precisely one of type or prototype bean name is specified.

B

BeanWrapperRowMapper<T> - Class in org.springframework.batch.item.excel.mapping

RowMapper implementation based on bean property paths.

BeanWrapperRowMapper() - Constructor for class org.springframework.batch.item.excel.mapping.BeanWrapperRowMapper

C

ColumnNameExtractor - Interface in org.springframework.batch.item.excel.support.rowset

Contract for extracting column names for a given sheet.

create(Sheet) - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSetFactory

create(Sheet) - Method in interface org.springframework.batch.item.excel.support.rowset.RowSetFactory

Create a rowset instance.

createBinder(Object) - Method in class org.springframework.batch.item.excel.mapping.BeanWrapperRowMapper

Create a binder for the target object.

D

DefaultRowSet - Class in org.springframework.batch.item.excel.support.rowset

Default implementation of the RowSet interface.

DefaultRowSetFactory - Class in org.springframework.batch.item.excel.support.rowset

RowSetFactory implementation which constructs a DefaultRowSet instance and DefaultRowSetMetaData instance.

DefaultRowSetFactory() - Constructor for class org.springframework.batch.item.excel.support.rowset.DefaultRowSetFactory

DefaultRowSetMetaData - Class in org.springframework.batch.item.excel.support.rowset

Default implementation for the RowSetMetaData interface.

doClose() - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

doClose() - Method in class org.springframework.batch.item.excel.jxl.JxlItemReader

Deprecated.

doClose() - Method in class org.springframework.batch.item.excel.poi.PoiItemReader

doOpen() - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

doRead() - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

E

ExcelFileParseException - Exception in org.springframework.batch.item.excel

Exception thrown when parsing excel files.

ExcelFileParseException(String, Throwable, String, String, int, String[]) - Constructor for exception org.springframework.batch.item.excel.ExcelFileParseException

Construct an ExcelFileParseException.

extractContents(Cell[]) - Static method in class org.springframework.batch.item.excel.jxl.JxlUtils

Deprecated. Extract the content from the given row.

G

getColumnCount() - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSetMetaData

getColumnCount() - Method in interface org.springframework.batch.item.excel.support.rowset.RowSetMetaData

Retrieves the number of columns in the RowSet.

getColumnName(int) - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSetMetaData

getColumnName(int) - Method in interface org.springframework.batch.item.excel.support.rowset.RowSetMetaData

Retrieves the column name for the indicatd column.

getColumnNames(Sheet) - Method in interface org.springframework.batch.item.excel.support.rowset.ColumnNameExtractor

Retrieves the names of the columns in the given Sheet.

getColumnNames() - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSetMetaData

getColumnNames(Sheet) - Method in class org.springframework.batch.item.excel.support.rowset.RowNumberColumnNameExtractor

getColumnNames() - Method in interface org.springframework.batch.item.excel.support.rowset.RowSetMetaData

Retrieves the names of the columns for the current sheet.

getColumnNames(Sheet) - Method in class org.springframework.batch.item.excel.support.rowset.StaticColumnNameExtractor

getColumnValue(int) - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSet

getColumnValue(int) - Method in interface org.springframework.batch.item.excel.support.rowset.RowSet

Retrieves the value of the indicated column in the current row as a String object.

getCurrentRow() - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSet

getCurrentRow() - Method in interface org.springframework.batch.item.excel.support.rowset.RowSet

Return the current row as a String[].

getCurrentRowIndex() - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSet

getCurrentRowIndex() - Method in interface org.springframework.batch.item.excel.support.rowset.RowSet

Returns the current row number

getFilename() - Method in exception org.springframework.batch.item.excel.ExcelFileParseException

getMetaData() - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSet

getMetaData() - Method in interface org.springframework.batch.item.excel.support.rowset.RowSet

Retrieves the meta data (name of the sheet, number of columns, names) of this row set.

getName() - Method in class org.springframework.batch.item.excel.jxl.JxlSheet

Deprecated. Get the name of the sheet.

getName() - Method in class org.springframework.batch.item.excel.poi.PoiSheet

Get the name of the sheet.

getName() - Method in interface org.springframework.batch.item.excel.Sheet

Get the name of the sheet.

getNumberOfRows() - Method in class org.springframework.batch.item.excel.jxl.JxlSheet

Deprecated. Get the number of rows in this sheet.

getNumberOfRows() - Method in class org.springframework.batch.item.excel.poi.PoiSheet

Get the number of rows in this sheet.

getNumberOfRows() - Method in interface org.springframework.batch.item.excel.Sheet

Get the number of rows in this sheet.

getNumberOfSheets() - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

The number of sheets in the underlying workbook.

getNumberOfSheets() - Method in class org.springframework.batch.item.excel.jxl.JxlItemReader

Deprecated.

getNumberOfSheets() - Method in class org.springframework.batch.item.excel.poi.PoiItemReader

getProperties() - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSet

getProperties() - Method in interface org.springframework.batch.item.excel.support.rowset.RowSet

Construct name-value pairs from the column names and string values.

getRow() - Method in exception org.springframework.batch.item.excel.ExcelFileParseException

getRow(int) - Method in class org.springframework.batch.item.excel.jxl.JxlSheet

Deprecated. Get the row as a String[].

getRow(int) - Method in class org.springframework.batch.item.excel.poi.PoiSheet

Get the row as a String[].

getRow(int) - Method in interface org.springframework.batch.item.excel.Sheet

Get the row as a String[].

getRowNumber() - Method in exception org.springframework.batch.item.excel.ExcelFileParseException

getSheet(int) - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

getSheet() - Method in exception org.springframework.batch.item.excel.ExcelFileParseException

getSheet(int) - Method in class org.springframework.batch.item.excel.jxl.JxlItemReader

Deprecated.

getSheet(int) - Method in class org.springframework.batch.item.excel.poi.PoiItemReader

getSheetName() - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSetMetaData

getSheetName() - Method in interface org.springframework.batch.item.excel.support.rowset.RowSetMetaData

Retrieves the name of the sheet the RowSet is based on.

H

handleRow(RowSet) - Method in interface org.springframework.batch.item.excel.RowCallbackHandler

hasSheets(Workbook) - Static method in class org.springframework.batch.item.excel.jxl.JxlUtils

Deprecated. Check if the given workbook has any sheets.

I

initBinder(DataBinder) - Method in class org.springframework.batch.item.excel.mapping.BeanWrapperRowMapper

Initialize a new binder instance.

isEmpty(Cell) - Static method in class org.springframework.batch.item.excel.jxl.JxlUtils

Deprecated. Checks if the given cell is emtpy.

isEmpty(Cell[]) - Static method in class org.springframework.batch.item.excel.jxl.JxlUtils

Deprecated. Check if the given row (Cell[]) is empty.

isRowEmpty(String[]) - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSet

J

jumpToItem(int) - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

On restart this will increment rowSet to where job left off previously

JxlItemReader<T> - Class in org.springframework.batch.item.excel.jxl

Deprecated. since JExcelAPI is an abandoned project (no release since 2009, with serious bugs remaining)

JxlItemReader() - Constructor for class org.springframework.batch.item.excel.jxl.JxlItemReader

Deprecated.

JxlSheet - Class in org.springframework.batch.item.excel.jxl

Deprecated. since JExcelAPI is an abandoned project (no release since 2009, with serious bugs remaining)

JxlUtils - Class in org.springframework.batch.item.excel.jxl

Deprecated. since JExcelAPI is an abandoned project (no release since 2009, with serious bugs remaining)

L

logger - Variable in class org.springframework.batch.item.excel.AbstractExcelItemReader

M

mapRow(RowSet) - Method in class org.springframework.batch.item.excel.mapping.BeanWrapperRowMapper

Map the org.springframework.batch.item.file.transform.FieldSet to an object retrieved from the enclosing Spring context, or to a new instance of the required type if no prototype is available.

mapRow(RowSet) - Method in class org.springframework.batch.item.excel.mapping.PassThroughRowMapper

mapRow(RowSet) - Method in interface org.springframework.batch.item.excel.RowMapper

Implementations must implement this method to map the provided row to the parameter type T.

N

next() - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSet

next() - Method in interface org.springframework.batch.item.excel.support.rowset.RowSet

Move to the next row in the document.

O

openExcelFile(Resource) - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

openExcelFile(Resource) - Method in class org.springframework.batch.item.excel.jxl.JxlItemReader

Deprecated.

openExcelFile(Resource) - Method in class org.springframework.batch.item.excel.poi.PoiItemReader

Open the underlying file using the WorkbookFactory.

org.springframework.batch.item.excel - package org.springframework.batch.item.excel

Core interfaces for reading Excel files

org.springframework.batch.item.excel.jxl - package org.springframework.batch.item.excel.jxl

Support classes for the JExcel library.

org.springframework.batch.item.excel.mapping - package org.springframework.batch.item.excel.mapping

Default RowMapper implementations.

org.springframework.batch.item.excel.poi - package org.springframework.batch.item.excel.poi

Support classes for the Apache POI library.

org.springframework.batch.item.excel.support.rowset - package org.springframework.batch.item.excel.support.rowset

RowSet abstraction for Excel documents

P

PassThroughRowMapper - Class in org.springframework.batch.item.excel.mapping

Pass through RowMapper useful for passing the orginal String[] back directly rather than a mapped object.

PassThroughRowMapper() - Constructor for class org.springframework.batch.item.excel.mapping.PassThroughRowMapper

PoiItemReader<T> - Class in org.springframework.batch.item.excel.poi

ItemReader implementation which uses apache POI to read an Excel file.

PoiItemReader() - Constructor for class org.springframework.batch.item.excel.poi.PoiItemReader

PoiSheet - Class in org.springframework.batch.item.excel.poi

Sheet implementation for Apache POI.

R

read() - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

RowCallbackHandler - Interface in org.springframework.batch.item.excel

Callback to handle skipped lines.

RowMapper<T> - Interface in org.springframework.batch.item.excel

Map rows from an excel sheet to an object.

RowNumberColumnNameExtractor - Class in org.springframework.batch.item.excel.support.rowset

ColumnNameExtractor which returns the values of a given row (default is 0) as the column names.

RowNumberColumnNameExtractor() - Constructor for class org.springframework.batch.item.excel.support.rowset.RowNumberColumnNameExtractor

RowSet - Interface in org.springframework.batch.item.excel.support.rowset

Used by the org.springframework.batch.item.excel.AbstractExcelItemReader to abstract away the complexities of the underlying Excel API implementations.

RowSetFactory - Interface in org.springframework.batch.item.excel.support.rowset

Contract for factories which will construct a RowSet implementation.

RowSetMetaData - Interface in org.springframework.batch.item.excel.support.rowset

Interface representing the the metadata associated with an Excel document.

S

setBeanFactory(BeanFactory) - Method in class org.springframework.batch.item.excel.mapping.BeanWrapperRowMapper

setColumnNameExtractor(ColumnNameExtractor) - Method in class org.springframework.batch.item.excel.support.rowset.DefaultRowSetFactory

setDistanceLimit(int) - Method in class org.springframework.batch.item.excel.mapping.BeanWrapperRowMapper

The maximum difference that can be tolerated in spelling between input key names and bean property names.

setEndAfterBlankLines(int) - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

setHeaderRowNumber(int) - Method in class org.springframework.batch.item.excel.support.rowset.RowNumberColumnNameExtractor

setLinesToSkip(int) - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

Set the number of lines to skip.

setPrototypeBeanName(String) - Method in class org.springframework.batch.item.excel.mapping.BeanWrapperRowMapper

The bean name (id) for an object that can be populated from the field set that will be passed into BeanWrapperRowMapper.mapRow(org.springframework.batch.item.excel.support.rowset.RowSet).

setResource(Resource) - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

Public setter for the input resource.

setRowMapper(RowMapper<T>) - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

Public setter for the rowMapper.

setRowSetFactory(RowSetFactory) - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

Public setter for the rowSetFactory.

setSkippedRowsCallback(RowCallbackHandler) - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

setStrict(boolean) - Method in class org.springframework.batch.item.excel.AbstractExcelItemReader

In strict mode the reader will throw an exception on AbstractItemCountingItemStreamItemReader.open(org.springframework.batch.item.ExecutionContext) if the input resource does not exist.

setStrict(boolean) - Method in class org.springframework.batch.item.excel.mapping.BeanWrapperRowMapper

Public setter for the 'strict' property.

setTargetType(Class<? extends T>) - Method in class org.springframework.batch.item.excel.mapping.BeanWrapperRowMapper

Public setter for the type of bean to create instead of using a prototype bean.

Sheet - Interface in org.springframework.batch.item.excel

Interface to wrap different Excel implementations like JExcel, JXL or Apache POI.

StaticColumnNameExtractor - Class in org.springframework.batch.item.excel.support.rowset

ColumnNameExtractor implementation which returns a preset String[] to use as the column names.

StaticColumnNameExtractor(String[]) - Constructor for class org.springframework.batch.item.excel.support.rowset.StaticColumnNameExtractor

A B C D E G H I J L M N O P R S