Routes one sheet from the enclosing ExcelInputStep's workbook, identified by name or index, to a next step, either as a whole Sheet object or as individually parsed rows. Configured as an entry in ExcelInputStep's nextSheetSteps list. When the parent step is set to process rows, rows are read starting at startRow and skipped when any of the columns listed in skipIfBlankColumns is blank, empty, or missing on that row. A disabled entry is skipped entirely.
Group: Pipelines
Properties
| Property | Returns | Description |
|---|---|---|
| disabled | boolean | Whether this sheet routing entry is skipped entirely by exec(), a convenient way to turn off a sheet without removing its configuration. |
| maxRows | Integer | The maximum row number to process for this sheet before processing stops early. |
| next | PipelineStep | The step which receives this sheet's data, either as a whole Sheet/Workbook or as individual rows. |
| sheetName | String | The sheet to route to, by name. |
| sheetNum | Integer | The sheet to route to, by zero-based index. |
| skipIfBlankColumns | List<Integer> | Column indexes which, when all are blank on a row, cause that row to be skipped rather than forwarded to the next step. |
| startRow | int | The zero-indexed row number at which row processing begins for this sheet. |
Methods
getSheetName()
Returns: String
The sheet to route to, by name.
getNext()
Returns: PipelineStep
The step which receives this sheet's data, either as a whole Sheet/Workbook or as individual rows.
getSheetNum()
Returns: Integer
The sheet to route to, by zero-based index.
getStartRow()
Returns: int
The zero-indexed row number at which row processing begins for this sheet.
getSkipIfBlankColumns()
Returns: List<Integer>
Column indexes which, when all are blank on a row, cause that row to be skipped rather than forwarded to the next step.
isDisabled()
Returns: boolean
Whether this sheet routing entry is skipped entirely by exec(), a convenient way to turn off a sheet without removing its configuration.
getMaxRows()
Returns: Integer
The maximum row number to process for this sheet before processing stops early.