Reader Directives

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

GET_LINE_TEXT

If the GET_LINE_TEXT directive is set to Yes in the mapping file (i.e., by default), the text associated with linear features is separated as gina_text.

For example:

springbrook_T_0010100233

The grouping name for the linear feature may be one of the following:

springbrook0010100233
springbrook_A_0010100233
springbrook_C_0010100233

In this case, the text feature and the linear feature have the same gina_feat_number attribute. Otherwise, those text strings are lost in the conversion because in most other formats, a linear feature does not support an associated text string.

Workbench Parameter: Separate Line Text

PLAN_CHOICE

Since coordinate system transformation may be performed during translation, it is suggested that each translation convert data in a single plan.

The PLAN_CHOICE directive can be set to any positive number or All, which is the default value. The user can use All when all plans have the same coordinate system or, more importantly, to enable the use of the gina_feat_plan attribute.

Users should check their data carefully, specify gina_feat_plan to convert the desired plan, and set the VISION* GINA reader coordinate system accordingly. For information on FME coordinate system support, see the FME on-line help files.

Workbench Parameter: Plan to translate

FORM_POLYGON

The FORM_POLYGON directive is used to provide the user with a choice to form polygon features.

In a GINA file, polygons are defined as relationships between polygon edges and centroids. If the user sets this directive to No, polygons are not formed, all edges are translated as linear features, and all centroids are translated as point features.

If the user sets this directive to Yes, polygons are formed and significantly more time may be required by the translation as it adopts a FME factory chain consisting of a PolygonFactory and a DonutFactory to form polygons.

If polygons are formed without modification of a mapping file (generated by FME with the GINA plug-in), the default FME factory chain contained in the mapping file is used. In this case, all formed polygon features are entered into a group named GINA_POLYGON.

The user can modify a mapping file to regroup formed polygon features. The method for grouping according to feature code, layer, and network is provided in the mapping file generated.

Workbench Parameter: Form Polygons

Modifying a Mapping File

To modify a mapping file for polygon regrouping:

  1. Remove the default FME factory definitions (i.e., remove the uncommented PolygonFactory and DonutFactory definitions in the mapping file generated).
  2. Uncomment the remaining PolygonFactory and DonutFactory definitions and treat those as a definition set.
  3. Search for groups with a name like *_P_* (e.g., yard_P_0401004013) in the mapping file.
  4. Make a set of the factory definitions for each of these groups by replacing the *** with the *_P_* in the definitions.

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