MsExcelRecordReader (easy-batch-msexcel 7.0.2 API)

java.lang.Object
- org.jeasy.batch.extensions.msexcel.MsExcelRecordReader

All Implemented Interfaces:

org.jeasy.batch.core.reader.RecordReader<org.apache.poi.ss.usermodel.Row>
```
public class MsExcelRecordReader
extends java.lang.Object
implements org.jeasy.batch.core.reader.RecordReader<org.apache.poi.ss.usermodel.Row>
```
Reader that reads data from a MS Excel sheet. Only MS Excel XLSX format is supported This reader produces MsExcelRecord instances.

Author:

Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)

Constructor Summary

Constructors
Constructor	Description
`MsExcelRecordReader(java.nio.file.Path path)`	Create a new `MsExcelRecordReader`.
`MsExcelRecordReader(java.nio.file.Path path, int sheetIndex)`	Create a new `MsExcelRecordReader`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

void close()

void open()

MsExcelRecord readRecord()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MsExcelRecordReader
```
public MsExcelRecordReader(java.nio.file.Path path)
                    throws java.io.IOException
```
    Create a new MsExcelRecordReader.
    
    Parameters:
    
    path - to the input file
    
    Throws:
    
    java.io.IOException - when an error occurs during file opening
  - MsExcelRecordReader
```
public MsExcelRecordReader(java.nio.file.Path path,
                           int sheetIndex)
                    throws java.io.IOException
```
    Create a new MsExcelRecordReader.
    
    Parameters:
    
    path - to the input file
    
    sheetIndex - the sheet index
    
    Throws:
    
    java.io.IOException - when an error occurs during file opening
- Method Detail
  - open
```
public void open()
```
    Specified by:
    
    open in interface org.jeasy.batch.core.reader.RecordReader<org.apache.poi.ss.usermodel.Row>
  - readRecord
```
public MsExcelRecord readRecord()
```
    Specified by:
    
    readRecord in interface org.jeasy.batch.core.reader.RecordReader<org.apache.poi.ss.usermodel.Row>
  - close
```
public void close()
           throws java.lang.Exception
```
    Specified by:
    
    close in interface org.jeasy.batch.core.reader.RecordReader<org.apache.poi.ss.usermodel.Row>
    
    Throws:
    
    java.lang.Exception