A AbstractSource that implements reading excel workbooks in xls format also known as HSSF.
Type | Name and description |
---|---|
boolean |
outputFormulaValues |
org.apache.poi.poifs.filesystem.POIFSFileSystem |
pfs |
java.lang.String |
sheet |
int |
startOnRow |
Constructor and description |
---|
XlsSource
(java.lang.String name, org.apache.poi.poifs.filesystem.POIFSFileSystem pfs, java.lang.String sheet = null) |
Type Params | Return Type | Name and description |
---|---|---|
|
void |
doStart(Pipeline pipeline) |
|
XlsSource |
outputFormulaValues(boolean output) Sets the values to output formula values vs the formula itself. |
|
XlsSource |
password(java.lang.String password) Sets the password if the xls file is protected. |
|
XlsSource |
startOnRow(int row) Sets the row to start reading the table data. |
|
static XlsSource |
xls(java.lang.String name, java.io.InputStream is, java.lang.String sheet = null) Reads the given InputStream as an excel format file (xls), and processes the tabular data on the given sheet. |
|
static XlsSource |
xls(java.io.File file, java.lang.String sheet = null) Reads the given excelFile and pulls out all of the tabular data on the given sheet. |
Sets the values to output formula values vs the formula itself. Default is true.
Sets the password if the xls file is protected.
password
- the give password to read the xls file.Sets the row to start reading the table data.
row
- the starting row of the data. Rows are 0-based indexes, and the first row is the header. Default is 0.Reads the given InputStream as an excel format file (xls), and processes the tabular data on the given sheet. If no sheet is provided it reads the first sheet of the workbook.
name
- The name of the underlying filestream
- The InputStream of the excel (xls) filesheet
- The name of the sheet to processReads the given excelFile and pulls out all of the tabular data on the given sheet. If not sheet is provided it will read the first sheet in the workbook.
excelFile
- The excel file to readsheet
- the name of the sheet to pull out, default is the first sheet.Groovy Documentation