Reader Directives
The suffix shown is prefixed by the current <ReaderKeyword>
in a mapping file.
By default, the <ReaderKeyword>
for the C++ TFS Variable Schema reader is TFS_VARIABLESCHEMA and the <ReaderKeyword>
for the Java TFS Variable Schema reader is com.mycompany.myformat.tfs_variableschema.tfs_variableschema
.
DATASET
The value for this directive is the TFS Variable Schema file(s) to be read.
Required/Optional
Required
Mapping File Syntax
A typical mapping file fragment specifying an input TFS Variable Schema dataset looks like:
TFS_VARIABLESCHEMA_DATASET /usr/data/tfs_variableschema/dataset.tfs
Workbench Parameter: Source Text Feature Store (TFS) Variable Schema File(s)
DEF
This directive contains the file’s feature type and the definitions of the attributes. There may be many DEF lines, one for each file to be read. The syntax of a TFS Variable Schema DEF line is:
<ReaderKeyword>_DEF <featureType> [<attrName> <attrType>]+
Required/Optional
Optional
ENCODING (C++ TFS Variable Schema)
This optional specification controls which character encoding is used to interpret text attributes from the TFS Variable Schema file. If the value is not set, then the text attributes will all be interpreted using the system encoding.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_ENCODING <encoding>
Parameter | Description |
---|---|
<encoding> |
The character encoding to use when interpreting text attributes. Must be set to any of the following values: ANSI - this means use the “current OS language” BIG5 EUC HKBIG5 ISO OEM SJIS UTF-8 CP437 CP708 CP720 CP737 CP775 CP850 CP852 CP855 CP857 CP860 CP861 CP862 CP863 CP864 CP865 CP866 CP869 CP874 CP932 CP936 CP950 CP1250 CP1251 CP1252 CP1253 CP1254 CP1255 CP1256 CP1257 CP1258 ISO8859-1 ISO8859-2 ISO8859-3 ISO8859-4 ISO8859-5 ISO8859-6 ISO8859-7 ISO8859-8 ISO8859-9 ISO8859-11 ISO8859-13 ISO8859-15 WINDOWS-874 |
Workbench Parameter
Character Encoding (optional)
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