Property Detail

• java.lang.String dateFormat

• java.io.File excelFile

• groovy.lang.Closure<java.lang.Void> headerClosure

• java.lang.String password

• java.lang.String sheet

• java.io.InputStream stream

Constructor Detail

• XlsxSource(java.lang.String name, java.io.InputStream stream, java.lang.String sheet = null)

  Reads the given InputStream as an excel format file (xlsx), 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 (xlsx) file

  sheet - The name of the sheet to process

• XlsxSource(java.io.File excelFile, 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.

Method Detail

• XlsxSource dateFormat(java.lang.String format)

  Sets the default format for dates (default format is yyyy-MM-dd). POI tends to return dates in Locale formats which aren't always convenient for working with so this sets the date format using the SimpleDateFormat syntax in Java.

  Parameters:

  format - format string following the rules set out in SimpleDateFormat

  Returns:

  this instance

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

• XlsxSource header(groovy.lang.Closure<java.lang.Void> headerClosure)

  Attaches a closure that will be called back when the headers are available.

  Parameters:

  headerClosure - the closure to call passing the headers as a java.util.List

  Returns:

  The XlsxSource for method chaining

• XlsxSource password(java.lang.String password)

  The password to use for encrypted spreadsheets

  Parameters:

  password - the given password to use to decrypt the stylesheet.

  Returns:

  this instance

• void setDateFormat(java.lang.String dateFormat)

• void setPassword(java.lang.String password)

• void setSheet(java.lang.String sheet)

• static XlsxSource xlsx(java.lang.String name, java.io.InputStream stream, java.lang.String sheet = null)

  Reads the given InputStream as an excel format file (xlsx), 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 (xlsx) file

  sheet - The name of the sheet to process

  Returns:

  The XlsxSource of the underlying excel data.

• static XlsxSource xlsx(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 XlsxSource of the underlying excel data.