The directives processed by the REGIS reader are listed below. The suffixes shown are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the REGIS reader is REGIS.
DATASET
Required/Optional: Required
The value for this keyword is the folder containing the REGIS files to be read, or the name of a single REGIS file to be read. A typical mapping file fragment specifying an input REGIS dataset looks like:
REGIS_DATASET /usr/data/REGIS
Workbench Parameter: Source Regional Geographic Information System (REGIS) File(s)
DEF
Required/Optional
Required
Each REGIS file must be defined before it is read. The definition specifies only the base name of the file, the type of geometry it contains, and the names and the types of all attributes. The syntax of a REGIS DEF line is:
<ReaderKeyword>_DEF <baseName> \ [<attrName> <attrType>]+
|
Field Type |
Description |
|
char(<width>) |
Character fields store fixed-length strings. The width parameter controls the maximum characters that can be stored by the field. When a character field is written, it is right-padded with blanks, or truncated, to fit the width. When a character field is retrieved, any padding blank characters are stripped away. |
|
date |
Date fields store dates as character strings with the format YYYYMMDD. |
|
logical |
Logical fields store TRUE/FALSE data. Data read to or written from such fields must always have a value of either true or false. |
|
number(<width>,<decimals>) |
Number fields store single and double precision floating point values. The width parameter is the total number of characters allocated to the field, including the decimal point. The decimals parameter controls the precision of the data and is the number of digits to the right of the decimal. |
The following mapping file fragment defines a sample REGIS line file.
REGIS_DEF landcover regis_type regis_line
IDs
Required/Optional
Optional
This optional specification is used to limit the available REGIS files read. If no IDs are specified, then all defined and available REGIS files are read. The syntax of the IDs keyword is:
<ReaderKeyword>_IDs <baseName1> \
<baseName2> … \
<baseNameN>
The base names correspond to those used in the DEF lines. The example below selects only the roads REGIS file for input during a translation:
REGIS_IDs roads
SEARCH_ENVELOPE
Using the minimum and maximum x and y parameters, define a bounding box that will be used to filter the input features. Only features that interact with the bounding box are returned.
If all four coordinates of the search envelope are specified as 0, the search envelope will be disabled.
Mapping File Syntax
<ReaderKeyword>_SEARCH_ENVELOPE <minX> <minY> <maxX> <maxY>
Note: If all four coordinates of the search envelope are specified as zero, the search envelope will be disabled.
Required/Optional
Optional
Workbench Parameter
Minimum X, Minimum Y, Maximum X, Maximum Y
SEARCH_ENVELOPE_COORDINATE_SYSTEM
This directive specifies the coordinate system of the search envelope if it is different than the coordinate system of the data.
The COORDINATE_SYSTEM directive, which specifies the coordinate system associated with the data to be read, must always be set if the SEARCH_ENVELOPE_COORDINATE_SYSTEM directive is set.
If this directive is set, the minimum and maximum points of the search envelope are reprojected from the SEARCH_ENVELOPE_COORDINATE_SYSTEM to the reader COORDINATE_SYSTEM prior to applying the envelope.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_SEARCH_ENVELOPE_COORDINATE_SYSTEM <coordinate system>
Workbench Parameter
Search Envelope Coordinate System
CLIP_TO_ENVELOPE
This directive specifies whether or not FME should clip features to the envelope specified in the SEARCH_ENVELOPE directive.
Values
YES | NO (default)
Mapping File Syntax
<ReaderKeyword>_CLIP_TO_ENVELOPE [yes | no]
Workbench Parameter
Clip To Envelope
EXPOSED_ATTRS
This directive allows the selection of format attributes to be explicitly added to the reader feature type.
This is similar to exposing format attributes on a reader feature type once it has been generated; however, it is even more powerful because it enables schema-driven applications other than Workbench to access and leverage these attributes as if they were explicitly on the schema as user attributes.
The result of picking a list of attributes is a comma-separated list of attribute names and types that will be added to the schema features. Currently all reader feature types will receive the same set of additional schema attributes for a given instance of the reader.
Required/Optional
Optional
Mapping File Syntax
Not applicable.
While it is possible for FME Objects applications to invoke this directive, the required format is not documented.
This directive is intended for use in our GUI applications (for example, Workbench) only.
Workbench Parameter
Additional Attributes to Expose