Parses an incoming fixed-width text file into rows of column values for a next step to process. Column boundaries are defined by columnWidths, a list of field lengths applied in order to split each line. Lines are read starting at startRow, skipping the first line as a header when startRow is non-zero, and each parsed row is passed on as a single call to the next step; rows where every configured skipIfBlankColumns entry is blank are skipped instead. Setting disabled turns the whole step into a no-op, useful for disabling it without removing its configuration.

Implements: PipelineStep


Properties

PropertyReturnsDescription
columnWidthsList<Integer>The width, in characters, of each column in a line, applied in order to split each line into fields. Lazily initialised to an empty list if not yet configured.
descriptionStringHuman-readable summary of this step, shown to administrators managing the pipeline: that it parses a fixed-width text file into rows.
disabledbooleanWhether this step is disabled, in which case exec() does nothing; a convenient way to turn off a step for debugging without removing its configuration.
formPathStringPath to the Velocity template used by the pipeline management UI to edit this step's configuration.
nextPipelineStepThe step that receives each parsed row of values.
nextStepPipelineStepThe step that receives each parsed row of values, same as getNext().
skipIfBlankColumnsList<Integer>Column indexes which, when all are blank on a row, cause that row to be skipped rather than forwarded to the next step.
startRowintThe zero-indexed row number where line reading begins; when non-zero the first line of the file is skipped as a header.

Methods

getFormPath()

Returns: String

Path to the Velocity template used by the pipeline management UI to edit this step's configuration.

getDescription()

Returns: String

Human-readable summary of this step, shown to administrators managing the pipeline: that it parses a fixed-width text file into rows.

getNext()

Returns: PipelineStep

The step that receives each parsed row of values.

getNextStep()

Returns: PipelineStep

The step that receives each parsed row of values, same as getNext().

getColumnWidths()

Returns: List<Integer>

The width, in characters, of each column in a line, applied in order to split each line into fields. Lazily initialised to an empty list if not yet configured.

isDisabled()

Returns: boolean

Whether this step is disabled, in which case exec() does nothing; a convenient way to turn off a step for debugging without removing its configuration.

getStartRow()

Returns: int

The zero-indexed row number where line reading begins; when non-zero the first line of the file is skipped as a header.

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.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.