Reader Directives
The directives listed below are processed by the CAT reader. The suffixes shown are prefixed by the current <ReaderKeyword>
in a mapping file.
By default, the <ReaderKeyword>
for the Column-Aligned Text reader is CAT
.
DATASET
This is the name of one or more CAT files.
Required/Optional
Required
Mapping File Syntax
CAT_DATASET /usr/data/filename.cat
Workbench Parameter
Column Aligned Text File(s)
FILTERING
If planning to filter based on the value of a column, set this value to yes and filtering will be enabled.
If filtering is enabled, only those rows that contain the FILTER_VALUE_ENCODED
in the column specified in FILTER_FIELD
will be returned as features.
Values
yes | no (default)
Required/Optional
Optional
FILTER_FIELD
This directive specifies the index of the column or field containing the value that will be tested. The column index starts at zero for the first column.
Values
<column number>
Required/Optional
This directive is required if FILTERING is set to yes; it is ignored if FILTERING is not set, or it is set to no.
FILTER_VALUE_ENCODED
This field specifies a value that the contents of the field in FILTER_FIELD must match. Whitespace is trimmed from the value before matching.
Values
<value>
Required/Optional
This directive is required if FILTERING is set to yes; it is ignored if FILTERING is not set, or it is set to no.
FILTER_INVERTED
This field specifies whether to include or exclude rows where the FILTER_FIELD matches FILTER_VALUE_ENCODED.
If FILTER_INVERTED is YES, then only rows that do not match the filter will be included.
If FILTER_INVERTED is NO, then rows that do not much the filter will be ignored.
Values
yes | no (default)
Required/Optional
This directive is required if FILTERING is set to yes; it is ignored if FILTERING is not set, or it is set to no.
SKIP_LINES
This directive identifies the number of lines to skip at the top of the file.
It is useful to enter a value for this directive if the Column-Aligned Text file contains a header line of field names or other descriptive material that should be skipped.
By default, all lines are included.
Values
<number>
Required/Optional
Optional
Workbench Parameter
Number of Lines to Skip
SCHEMA
Schema specifies the name, type and width of the fields that comprise a row. The name is any valid attribute name. The types can be any of the field types described in the table below. The width is a positive value that is the length of the field in characters.
Field Type | Description |
---|---|
integer | Integer fields store integer values. |
real | Real fields store single and double precision floating point values. |
string | String fields store fixed-length strings. When a character field is read, any padding blanks will be stripped from the string. |
x-coordinate | X-Coordinate fields store the x coordinate of the feature as a floating point value. It is interpreted in the same way as a real field. |
y-coordinate | Y-Coordinate fields store the y coordinate of the feature as a floating point value. It is interpreted in the same way as a real field. |
z-coordinate | Z-Coordinate fields store the z coordinate of the feature as a floating point value. It is interpreted in the same way as a real field. |
ignore | Fields marked as ignore are not stored and are not part of the feature. |
Fields containing x, y or z coordinates will comprise the point geometry of the feature, while fields with the type integer
, real
or string
will be attributes. The type ignore
indicates the field will be skipped.
The ordering of the fields is important. The first field always starts at the first character in a row and is width characters wide. Subsequent fields start where the previous field ends.
Values
<fieldname, type, width triplet list>
Required/Optional
Required