Provides typed, null-safe access to a pipeline row's column values, and is the object exposed as "columns" to MVEL column expressions. Wraps the raw args array passed between pipeline steps together with the column definitions and pipeline attributes, and offers per-type accessors (string, date, boolean, integer, decimal) that resolve a value by its field name and, where the column defines one, evaluate its MVEL expression. Also provides the static helpers used to convert between spreadsheet-style column letters and zero-indexed column numbers.
Properties
| Property | Returns | Description |
|---|---|---|
| dataBinder | DataBinder | The data binder resolved from the current request context, used to bind resolved values onto target entities. |
| orgTimezone | String |
Methods
getRawVal(Object[] args, String fieldName) · getRawVal(Object[] args, Column col) · getString(Object[] args, String fieldName) · getBigDecimal(Object[] args, String fieldName) · getInteger(Object[] args, String fieldName) · getDouble(Object[] args, String fieldName) · getBoolean(Object[] args, String fieldName) · getDate(Object[] args, String fieldName) · hasKey(String name) · getDataBinder() · getValuesMap(Object[] args) · parseDate(Object o)
getRawVal(Object[] args, String fieldName)
Returns: Object
Looks up the column configured under the given field name and resolves its raw value from the row, applying its MVEL expression if it has one.
| Parameter | Description |
|---|---|
args | the current pipeline row, as an array of positional values |
fieldName | the field name of the column to resolve, as configured on this helper's column map |
getRawVal(Object[] args, Column col)
Returns: Object
Resolves the value for the given column from the row: from a column index, a column letter, a pipeline attribute or a constant, in that order of preference, then applies the column's MVEL expression if it has one.
| Parameter | Description |
|---|---|
args | the current pipeline row, as an array of positional values |
col | the column definition to resolve a value for |
getString(Object[] args, String fieldName)
Returns: String
Resolves the named column's value and converts it to a trimmed string.
| Parameter | Description |
|---|---|
args | the current pipeline row, as an array of positional values |
fieldName | the field name of the column to resolve |
getBigDecimal(Object[] args, String fieldName)
Returns: BigDecimal
Resolves the named column's value and converts it to a decimal number. Recognises the strings "yes"/"true" as one and "no"/"false" as zero before falling back to the formatter's general numeric conversion.
| Parameter | Description |
|---|---|
args | the current pipeline row, as an array of positional values |
fieldName | the field name of the column to resolve |
getInteger(Object[] args, String fieldName)
Returns: Integer
Resolves the named column's value and converts it to an integer.
| Parameter | Description |
|---|---|
args | the current pipeline row, as an array of positional values |
fieldName | the field name of the column to resolve |
getDouble(Object[] args, String fieldName)
Returns: Double
Resolves the named column's value and converts it to a double.
| Parameter | Description |
|---|---|
args | the current pipeline row, as an array of positional values |
fieldName | the field name of the column to resolve |
getBoolean(Object[] args, String fieldName)
Returns: Boolean
Resolves the named column's value and converts it to a boolean.
| Parameter | Description |
|---|---|
args | the current pipeline row, as an array of positional values |
fieldName | the field name of the column to resolve |
getDate(Object[] args, String fieldName)
Returns: Date
Resolves the named column's value and converts it to a date, using the pipeline website's organisation timezone.
| Parameter | Description |
|---|---|
args | the current pipeline row, as an array of positional values |
fieldName | the field name of the column to resolve |
hasKey(String name)
Returns: boolean
Checks whether a column is configured under the given field name.
| Parameter | Description |
|---|---|
name | the field name to look up |
getDataBinder()
Returns: DataBinder
The data binder resolved from the current request context, used to bind resolved values onto target entities.
getValuesMap(Object[] args)
Returns: Map
Resolves every configured column against the given row and returns the results as a map keyed by field name.
| Parameter | Description |
|---|---|
args | the current pipeline row, as an array of positional values |
parseDate(Object o)
Returns: Date
Parses an arbitrary value into a date, using the pipeline website's organisation timezone.
| Parameter | Description |
|---|---|
o | the value to parse, typically a string or an existing date |