Reader Directives

The suffixes shown are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the EDIGéO reader is EDIGEO.

DATASET

Required/Optional: Required

The value for this directive is the EDIGéO exchange file containing the EDIGéO dataset to be read.

Example:

EDIGEO_DATASET /usr/data/12345678.THF

Workbench Parameter: Source EDIGEO File(s)

READ_RAW_DATA

Required/Optional: Required

This directive indicates whether the EDIGéO reader will not process the data that is read from the dataset to create higher order topological features.

In a EDIGéO dataset, when data is read without any processing, feature primitives do not have any geometry. Instead, “links” must be read from the dataset to link the feature primitives to geographical primitives.

Thus, when this directive is set to NO, a significant amount of processing is done to construct each feature. In this process, not all of the original information can be output by the reader.

If this directive is set to YES, data will be output by the reader exactly how the data is represented in the file. When this directive is set to YES, the directives READ_QUALITY_DATA, ADD_QUALITY_REFERENCE, and CNIG_NAME_COMPLETION will have an implied value of NO.

Value: YES | NO

Default Value: NO

Example:

A typical mapping file fragment specifying that data be read without any processing looks like:

EDIGEO_READ_RAW_DATA YES

READ_QUALITY_DATA

Required/Optional: Optional

This directive indicates whether quality features are read by the reader.

Quality features have no geometry, and their feature type name will be a three-letter code. These quality features carry information that is complementary to topological features.

Value: YES | NO

Default Value: NO

Example:

READ_QUALITY_DATA YES

ADD_QUALITY_REFERENCE

Required/Optional: Optional

This directive indicates whether a list attribute, which carries values that reference quality features, is added to topological features.

The structured list attribute, which holds references to quality features, is named qal{}.ref_id. The format for the elements in this list is identical to the format of the format attribute edigeo_code.

Value: YES | NO

Default Value: NO

Example:

ADD_QUALITY_REFERENCE YES

CNIG_NAME_COMPLETION

Required/Optional: Optional

This directive indicates whether feature type names will in an EDIGéO object code format, or feature type names will appear as Conseil National de l'information Géographique (CNIG) nomenclatures.

An EDIGéO object code classification system is comprised of one alphabetical character followed by four numerics, each element delimited by an underscore (for example, H_11_4_0). If this directive is set to YES, the reader will use the corresponding CNIG nomenclature instead of the EDIGéO object code (for example, H_11_4_0 will become PARCELLE).

Value: YES | NO

Default Value: NO

Example:

CNIG_NAME_COMPLETION YES

EDIGEO_ERROR_OUTPUT

Required/Optional: Optional

This directive indicates whether verbose warnings and errors are output to the log file. These messages are in French.

Value: YES | NO

Default Value: NO

Example:

EDIGEO_ERROR_OUTPUT YES

Workbench Parameter: Log French error output

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