A match field that tests an exact value against the row, where the acceptable input values are supplied by evaluating a kcode expression. Written as a "term" element inside a lookup-table definition. A row matches if the row's cell value for this field is blank (unconstrained) or is contained in the set of values produced by the kcode expression.
Group: Queries
Extends: PersistedLookupTableField
Implements: MatchLookupTableField
Properties
| Property | Returns | Description |
|---|---|---|
| kcodeSource | String | The kcode expression that is evaluated to produce the acceptable input values for this field. |
Inherited from PersistedLookupTableField
Properties
| Property | Returns | Description |
|---|---|---|
| column | int | The zero-based CSV column this field reads its value from. |
| name | String | The name of this field, used as the key when looking up match parameters and output values. |
| type | String | The data type of this field, corresponding to Field.getType. |
Methods
getName()
Returns: String
The name of this field, used as the key when looking up match parameters and output values.
getType()
Returns: String
The data type of this field, corresponding to Field.getType.
getColumn()
Returns: int
The zero-based CSV column this field reads its value from.
value(List row)
Returns: String
Reads this field's value from the given data row.
| Parameter | Description |
|---|---|
row | the CSV row to read from |
Methods
matches(List row, Map<String,Set<Object>> filterParams)
Returns: boolean
Tests whether the given row matches this field's constraint. A blank cell value is treated as unconstrained and always matches; otherwise the row matches if its cell value is present in the parameter values for this field's name.
| Parameter | Description |
|---|---|
row | the data row to test |
filterParams | the candidate values for each match field, keyed by field name |
getKcodeSource()
Returns: String
The kcode expression that is evaluated to produce the acceptable input values for this field.