Property Detail

• boolean outputFormulaValues

• org.apache.poi.poifs.filesystem.POIFSFileSystem pfs

• java.lang.String sheet

• int startOnRow

Constructor Detail

• XlsSource(java.lang.String name, org.apache.poi.poifs.filesystem.POIFSFileSystem pfs, java.lang.String sheet = null)

Method Detail

• @java.lang.Override void doStart(Pipeline pipeline)

• XlsSource outputFormulaValues(boolean output)

  Sets the values to output formula values vs the formula itself. Default is true.

  Parameters:

  output

  Returns:

• XlsSource password(java.lang.String password)

  Sets the password if the xls file is protected.

  Parameters:

  password - the give password to read the xls file.

  Returns:

  The given XlsSource

• XlsSource startOnRow(int row)

  Sets the row to start reading the table data.

  Parameters:

  row - the starting row of the data. Rows are 0-based indexes, and the first row is the header. Default is 0.

  Returns:

  the given XlsSource

• 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. If no sheet is provided it reads the first sheet of the workbook.

  Parameters:

  name - The name of the underlying file

  stream - The InputStream of the excel (xls) file

  sheet - The name of the sheet to process

  Returns:

  The XlsSource of the underlying excel data.

• 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. If not sheet is provided it will read the first sheet in the workbook.

  Parameters:

  excelFile - The excel file to read

  sheet - the name of the sheet to pull out, default is the first sheet.

  Returns:

  The XlsSource of the underlying excel data.