Index (Spring Batch Excel 0.1.1 API)

A B C D E G H I J L M N O P R S
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractExcelItemReader<T> - Class in org.springframework.batch.extensions.excel: ItemReader implementation to read an Excel file.
AbstractExcelItemReader() - Constructor for class org.springframework.batch.extensions.excel.AbstractExcelItemReader
afterPropertiesSet() - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader
afterPropertiesSet() - Method in class org.springframework.batch.extensions.excel.mapping.BeanWrapperRowMapper: Check that precisely one of type or prototype bean name is specified.

B

BeanWrapperRowMapper<T> - Class in org.springframework.batch.extensions.excel.mapping: RowMapper implementation based on bean property paths.
BeanWrapperRowMapper() - Constructor for class org.springframework.batch.extensions.excel.mapping.BeanWrapperRowMapper

C

close() - Method in interface org.springframework.batch.extensions.excel.Sheet
ColumnNameExtractor - Interface in org.springframework.batch.extensions.excel.support.rowset: Contract for extracting column names for a given sheet.
create(Sheet) - Method in class org.springframework.batch.extensions.excel.support.rowset.DefaultRowSetFactory
create(Sheet) - Method in interface org.springframework.batch.extensions.excel.support.rowset.RowSetFactory: Create a rowset instance.
createBinder(Object) - Method in class org.springframework.batch.extensions.excel.mapping.BeanWrapperRowMapper: Create a binder for the target object.

D

DefaultRowSet - Class in org.springframework.batch.extensions.excel.support.rowset: Default implementation of the RowSet interface.
DefaultRowSetFactory - Class in org.springframework.batch.extensions.excel.support.rowset: RowSetFactory implementation which constructs a DefaultRowSet instance and DefaultRowSetMetaData instance.
DefaultRowSetFactory() - Constructor for class org.springframework.batch.extensions.excel.support.rowset.DefaultRowSetFactory
DefaultRowSetMetaData - Class in org.springframework.batch.extensions.excel.support.rowset: Default implementation for the RowSetMetaData interface.
doClose() - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader
doClose() - Method in class org.springframework.batch.extensions.excel.poi.PoiItemReader
doClose() - Method in class org.springframework.batch.extensions.excel.streaming.StreamingXlsxItemReader
doOpen() - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader
doRead() - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader

E

ExcelFileParseException - Exception in org.springframework.batch.extensions.excel: Exception thrown when parsing excel files.
ExcelFileParseException(String, Throwable, String, String, int, String[]) - Constructor for exception org.springframework.batch.extensions.excel.ExcelFileParseException: Construct an ExcelFileParseException.

G

getColumnNames() - Method in class org.springframework.batch.extensions.excel.support.rowset.DefaultRowSetMetaData
getColumnNames() - Method in interface org.springframework.batch.extensions.excel.support.rowset.RowSetMetaData: Retrieves the names of the columns for the current sheet.
getColumnNames(Sheet) - Method in interface org.springframework.batch.extensions.excel.support.rowset.ColumnNameExtractor: Retrieves the names of the columns in the given Sheet.
getColumnNames(Sheet) - Method in class org.springframework.batch.extensions.excel.support.rowset.RowNumberColumnNameExtractor
getColumnNames(Sheet) - Method in class org.springframework.batch.extensions.excel.support.rowset.StaticColumnNameExtractor
getCurrentRow() - Method in class org.springframework.batch.extensions.excel.support.rowset.DefaultRowSet
getCurrentRow() - Method in interface org.springframework.batch.extensions.excel.support.rowset.RowSet: Return the current row as a String[].
getCurrentRowIndex() - Method in class org.springframework.batch.extensions.excel.support.rowset.DefaultRowSet
getCurrentRowIndex() - Method in interface org.springframework.batch.extensions.excel.support.rowset.RowSet: Returns the current row number.
getFilename() - Method in exception org.springframework.batch.extensions.excel.ExcelFileParseException
getMetaData() - Method in class org.springframework.batch.extensions.excel.support.rowset.DefaultRowSet
getMetaData() - Method in interface org.springframework.batch.extensions.excel.support.rowset.RowSet: Retrieves the meta data (name of the sheet, number of columns, names) of this row set.
getName() - Method in interface org.springframework.batch.extensions.excel.Sheet: Get the name of the sheet.
getNumberOfRows() - Method in interface org.springframework.batch.extensions.excel.Sheet: Get the number of rows in this sheet.
getNumberOfSheets() - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader: The number of sheets in the underlying workbook.
getNumberOfSheets() - Method in class org.springframework.batch.extensions.excel.poi.PoiItemReader
getNumberOfSheets() - Method in class org.springframework.batch.extensions.excel.streaming.StreamingXlsxItemReader
getProperties() - Method in class org.springframework.batch.extensions.excel.support.rowset.DefaultRowSet
getProperties() - Method in interface org.springframework.batch.extensions.excel.support.rowset.RowSet: Construct name-value pairs from the column names and string values.
getRow() - Method in exception org.springframework.batch.extensions.excel.ExcelFileParseException
getRow(int) - Method in interface org.springframework.batch.extensions.excel.Sheet: Get the row as a String[].
getRowNumber() - Method in exception org.springframework.batch.extensions.excel.ExcelFileParseException
getSheet() - Method in exception org.springframework.batch.extensions.excel.ExcelFileParseException
getSheet(int) - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader: Get the sheet based on the given sheet index.
getSheet(int) - Method in class org.springframework.batch.extensions.excel.poi.PoiItemReader
getSheet(int) - Method in class org.springframework.batch.extensions.excel.streaming.StreamingXlsxItemReader
getSheetName() - Method in class org.springframework.batch.extensions.excel.support.rowset.DefaultRowSetMetaData
getSheetName() - Method in interface org.springframework.batch.extensions.excel.support.rowset.RowSetMetaData: Retrieves the name of the sheet the RowSet is based on.

H

handleRow(RowSet) - Method in interface org.springframework.batch.extensions.excel.RowCallbackHandler: Implementations must implement this method to process each row of data in the RowSet.

I

initBinder(DataBinder) - Method in class org.springframework.batch.extensions.excel.mapping.BeanWrapperRowMapper: Initialize a new binder instance.

J

jumpToItem(int) - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader: On restart this will increment rowSet to where job left off previously.

L

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

M

mapRow(RowSet) - Method in class org.springframework.batch.extensions.excel.mapping.BeanWrapperRowMapper: Map the 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.extensions.excel.mapping.PassThroughRowMapper
mapRow(RowSet) - Method in interface org.springframework.batch.extensions.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.extensions.excel.support.rowset.DefaultRowSet
next() - Method in interface org.springframework.batch.extensions.excel.support.rowset.RowSet: Move to the next row in the document.

O

openExcelFile(Resource, String) - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader: Opens the excel file and reads the file and sheet metadata.
openExcelFile(Resource, String) - Method in class org.springframework.batch.extensions.excel.poi.PoiItemReader: Open the underlying file using the WorkbookFactory.
openExcelFile(Resource, String) - Method in class org.springframework.batch.extensions.excel.streaming.StreamingXlsxItemReader
org.springframework.batch.extensions.excel - package org.springframework.batch.extensions.excel: Core interfaces for reading Excel files.
org.springframework.batch.extensions.excel.mapping - package org.springframework.batch.extensions.excel.mapping: Default RowMapper implementations.
org.springframework.batch.extensions.excel.poi - package org.springframework.batch.extensions.excel.poi: Support classes for the Apache POI library.
org.springframework.batch.extensions.excel.streaming - package org.springframework.batch.extensions.excel.streaming: Streaming implementation of ItemReaders.
org.springframework.batch.extensions.excel.support.rowset - package org.springframework.batch.extensions.excel.support.rowset: RowSet abstraction for Excel documents.

P

PassThroughRowMapper - Class in org.springframework.batch.extensions.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.extensions.excel.mapping.PassThroughRowMapper
PoiItemReader<T> - Class in org.springframework.batch.extensions.excel.poi: ItemReader implementation which uses apache POI to read an Excel file.
PoiItemReader() - Constructor for class org.springframework.batch.extensions.excel.poi.PoiItemReader

R

read() - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader
RowCallbackHandler - Interface in org.springframework.batch.extensions.excel: Callback to handle skipped lines.
RowMapper<T> - Interface in org.springframework.batch.extensions.excel: Map rows from an excel sheet to an object.
RowNumberColumnNameExtractor - Class in org.springframework.batch.extensions.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.extensions.excel.support.rowset.RowNumberColumnNameExtractor
RowSet - Interface in org.springframework.batch.extensions.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.extensions.excel.support.rowset: Contract for factories which will construct a RowSet implementation.
RowSetMetaData - Interface in org.springframework.batch.extensions.excel.support.rowset: Interface representing the the metadata associated with an Excel document.

S

setBeanFactory(BeanFactory) - Method in class org.springframework.batch.extensions.excel.mapping.BeanWrapperRowMapper
setColumnNameExtractor(ColumnNameExtractor) - Method in class org.springframework.batch.extensions.excel.support.rowset.DefaultRowSetFactory
setDatesAsIso(boolean) - Method in class org.springframework.batch.extensions.excel.poi.PoiItemReader: Instead of using the format defined in the Excel sheet, read the date/time fields as an ISO formatted string instead.
setDistanceLimit(int) - Method in class org.springframework.batch.extensions.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.extensions.excel.AbstractExcelItemReader
setHeaderRowNumber(int) - Method in class org.springframework.batch.extensions.excel.support.rowset.RowNumberColumnNameExtractor
setLinesToSkip(int) - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader: Set the number of lines to skip.
setPassword(String) - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader: The password used to protect the file to open.
setPrototypeBeanName(String) - Method in class org.springframework.batch.extensions.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(RowSet).
setResource(Resource) - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader: Public setter for the input resource.
setRowMapper(RowMapper<T>) - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader: Public setter for the rowMapper.
setRowSetFactory(RowSetFactory) - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader: Public setter for the rowSetFactory.
setSkippedRowsCallback(RowCallbackHandler) - Method in class org.springframework.batch.extensions.excel.AbstractExcelItemReader: Set the callback handler to call when a row is being skipped.
setStrict(boolean) - Method in class org.springframework.batch.extensions.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.extensions.excel.mapping.BeanWrapperRowMapper: Public setter for the 'strict' property.
setTargetType(Class<? extends T>) - Method in class org.springframework.batch.extensions.excel.mapping.BeanWrapperRowMapper: Public setter for the type of bean to create instead of using a prototype bean.
Sheet - Interface in org.springframework.batch.extensions.excel: Interface to wrap different Excel implementations like JExcel or Apache POI.
StaticColumnNameExtractor - Class in org.springframework.batch.extensions.excel.support.rowset: ColumnNameExtractor implementation which returns a preset String[] to use as the column names.
StaticColumnNameExtractor(String[]) - Constructor for class org.springframework.batch.extensions.excel.support.rowset.StaticColumnNameExtractor
StreamingXlsxItemReader<T> - Class in org.springframework.batch.extensions.excel.streaming: Simple streaming reader without Apache POI.
StreamingXlsxItemReader() - Constructor for class org.springframework.batch.extensions.excel.streaming.StreamingXlsxItemReader

A B C D E G H I J L M N O P R S
All Classes and Interfaces|All Packages|Serialized Form