Reader Directives

The suffixes listed are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the GMLSF reader is GMLSF.

DATASET

Required/Optional: Required

This directive specifies the location for the input GML instance document.

Example:

GMLSF_DATASET c:\gml_data\hydro.xml

Workbench Parameter: Source GML SF-0 File(s)

SYSTEM_ENCODING

Required/Optional: Optional

Specifies the encoding to use for the GML schema and data features that are read by the reader. If not set, then features will be output in the system’s encoding.

Example:

GMLSF_SYSTEM_ENCODING UTF-8

Workbench Parameter: System encoding

XSD_DOC

Required/Optional: Optional

A GML instance document specifies the namespace and the location of its application schema through its root element xsi:schemaLocation attribute. This directive allows the GML reader to use a different GML schema document from the one specified in the xsi:schemaLocation attribute.

Example:

GMLSF_XSD_DOC c:\data\gmlsf\myschema.xsd

Workbench Parameter: Application Schema

CONTINUE_ON_GEOM_ERROR

Required/Optional: Optional

Rather than halting the reader, this optional directive allows the reader to continue reading and extracting features from the input GML document stream upon encountering a geometrical error. The valid values of this directive are YES and NO, its default value is YES.

Example:

GMLSF_CONTINUE_ON_GEOM_ERROR NO

Workbench Parameter: Continue on Geometry Error

HTTP_PROXY

Required/Optional: Optional

This directive specifies the HTTP proxy to be used for network fetches. The port number may be specified at the end of the proxy by appending :[port number] or through the HTTP_PROXY_PORT directive.

Example:

GMLSF_HTTP_PROXY www.someproxy.net

or

GMLSF_HTTP_PROXY www.someproxy.net:8082

Note: Users may bypass the HTTP_PROXY and HTTP_PROXY directives and still have http proxy support by specifying the http_proxy environment variable. The value for this environment variable should be of the form [protocol://][user:password@]machine[:port], where components within [ ] are optional. An example value for the http_proxy environment variable is: http://www.someproxy.net:8885.

Workbench Parameter: Proxy Address

HTTP_PROXY_PORT

Required/Optional: Optional

This directive is used if the HTTP proxy port was not specified in the HTTP_PROXY directive.

Example:

GMLSF_HTTP_PROXY_PORT 8081

Workbench Parameter: Port

CACHE_XSD

Required/Optional: Optional

This directive allows the XML Schema documents that are fetched from the internet to be cached locally, this reduces the number of network fetches when traversing the GML schema documents. The valid values of this directive are YES and NO, its default value is YES.

Example:

GMLSF_CACHE_XSD NO

Workbench Parameter: Cache XSD Documents

CACHE_XSD_EXPIRY_TIME

Required/Optional: Optional

This directive is optional and takes effect only if the CACHE_XSD directive is set to YES. The valid values for this directive are positive numbers denoting the number of seconds. The default value for this directive is 300.

Example:

GMLSF_CACHE_XSD_EXPIRY_TIME 600

Workbench Parameter: Cache XSD Expiry Time

CACHE_XSD_DIRECTORY

Required/Optional: Optional

This optional directive takes effect when CACHE_XSD directive is set to YES. The directive specifies the folder path for the location of the cache xsd folder, the folder name for the cache xsd folder is specified by the CACHE_XSD_NAME directive below. The default value for this directive is the user’s temporary folder.

Example:

GMLSF_CACHE_XSD_DIRECTORY c:\tmp

CACHE_XSD_NAME

Required/Optional: Optional

This optional directive specifies the xsd cache name. The cache name must also be a valid folder name, as this value is used as the sub-folder containing the cached schema documents within the CACHE_XSD_DIRECTORY. The default value for this directive is GML_XSD_CACHE.

Example:

GMLSF_CACHE_XSD_NAME gml_schema_cache

SRS_AXIS_ORDER

Required/Optional: Optional

This optional directive allows the user to override the axis order used by the reader when reading a GML document. The directive specifies axis order to use when reading a coordinate tuple in a GML <pos> or <posList> element. The valid values for this directive are “1,2”, “2,1”, “1,2,3” and “2,1,3”. There is no default value.

For example, if the GMLSF reader is making a mistake interpreting the coordinates and the user knows that a particular GML document contains coordinate tuples in lat-lon-height order then this directive should be set to “2,1,3”.

Mapping File Syntax

GML_SRS_AXIS_ORDER 2,1,3

Workbench Parameter: GML SRS Axis Order

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