Reader Directives

The directives listed below are processed by the StruMap reader. The suffixes listed are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the StruMap reader is STRUMAP.

DATASET

Required/Optional: Required

The value for this keyword is the folder containing the StruMap files to be read. A typical mapping file fragment specifying an input StruMap dataset looks like:

Example:

STRUMAP_DATASET /usr/data/strumap/input.sgf

Workbench Parameter: Source Northgate StruMap File(s)

DEF

Required/Optional

Required

Each StruMap feature must be defined before it can be read. The definition specifies the feature code of the feature, and the names and the types of all attributes. The syntax of a StruMap DEF line is:

            <ReaderKeyword>_DEF <baseName> \
	[<attrName> <attrType>]+

The following table shows the attribute types supported.

Field Type

Description

char(<width>)

Character fields store fixed length strings. The width parameter controls the maximum number of characters that can be stored by the field. No padding is required for strings shorter than this width.

date

Date fields store date as character strings with the format YYYYMMDD.

double

Float fields store 64-bit floating point values. There is no ability to specify the precision and width of the field.

integer

Integer fields store 32-bit signed integers.

logical

Logical fields store TRUE/FALSE data. Data read or written from and to such fields must always have a value of either true or false.

IDs

Required/Optional

Optional

This optional specification limits StruMap features read. If no IDs are specified, then all StruMap features in the input file are read.

The syntax of the IDs keyword is:

            <ReaderKeyword>_IDs <baseName> \
	<baseName1> \
	<baseNameN> 

The basenames must match those used in DEF lines.

The example below selects only the roads StruMap feature for input during a translation:

STRUMAP_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