Reader Directives

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

DATASET

Required/Optional: Required

The value for this directive is the file containing the FF dataset to be read.

Example:

FF_DATASET /usr/data/input.ff

FF_PARAMETERFILE

Required/Optional: Optional

This setting gives the name of the file that is used as a parameter file. This file is created by the FF reader and is used to store many metadata values for future use with other formats.

Example:

FF_PARAMETERFILE /usr/data/autoka.par

The contents of a typical parameter file look like this:

-- Metadata for translation back into a Transfer File --
-- Original filename : C:\Data\city.ff

FFVER 9
ISONR 1
RUBRIK "AutoKa-PC Lokal ADB"
BANKNAMN "  "
BASNAMN "007LYRAN\CLUSTER"
PLANSYSTEM "  "
HOJDSYSTEM "  "
BASORIGOX 7000000
BASORIGOY 1500000
BASXYPREC -3
BASORIGOZ 0
BASZPREC -3
XIDLGDMAX 64
BASDATUM “1997-11-25, 21:14”
BASSIGN “  “

FIX_SELF_INTERSECTING_POLYGONS

Required/Optional: Optional

This setting determines whether self-intersecting polygons are broken up into non-intersecting polygons.

A typical mapping file fragment specifying an input FF dataset looks like:

FF_FIX_SELF_INTERSECTING_POLYGONS YES

Range: YES or NO

Default: NO

OUTPUT_POLYGON_EDGES

Required/Optional: Optional

This setting determines whether lines used to build polygon geometries should also be read and presented as separate lines.

A typical mapping file fragment specifying an input FF dataset looks like:

FF_OUTPUT_POLYGON_EDGES YES

Range: YES or NO

Default: NO

SUPPRESS_TEXT_POINTS

Required/Optional: Optional

This setting determines whether texts attached to point geometries should be extracted to standalone texts with their own point geometry. The value set to YES results in text-features being made for those points that have a list called ff_text_point{}. If the value is set to NO the user can later chose to create text by using an ElementFactory with the ff_text_point list.

A typical mapping file fragment specifying an input FF dataset looks like:

FF_SUPPRESS_TEXT_POINTS YES

Range: YES or NO

Default: NO

BUILD_CLUSTERS

Required/Optional: Optional

When this directive is set to NO, no clusters are built. The user can later rebuild clusters by using the AggregateFactory and the ff_up_cluster attribute.

A typical mapping file fragment specifying an input FF dataset looks like:

FF_BUILD_CLUSTERS YES

Range: YES or NO

Default: YES

BUILD_MULTI_GEOMETRY_CLUSTERS

Required/Optional: Optional

In TransferFiles (FF-files), clusters may have a mix of features with different geometry types, but by default such clusters are not built.

If you want to build clusters with different geometries, this directive must be set to YES.

Note: This will generate objects that are not commonly supported by other formats, so with this setting you may have to split the clusters before sending them to the writer.

A typical mapping file fragment specifying an input FF dataset looks like:

FF_BUILD_MULTI_GEOMETRY_CLUSTERS YES

Range: YES or NO

Default: NO

NULL_HEIGHT_REPLACE_VALUE

In FF, a 3D line or area (polygon) is not required to have heights on all vertices.

A vertex with unknown height will have a height value of NaN (Not a Number).

Very few formats allow vertices to have unknown heights, so this directive allows you to replace all NaN height values with a default height value.

Note: This will not turn 2D-features into 3D-features: only NaN values on 3D-features will be replaced.

Required/Optional

Optional

Mapping File Example

FF_NULL_HEIGHT_REPLACE_VALUE 123.456

TRIM_DEP_ATTRIBUTE

Required/Optional: Optional

The dep-attribute (dep = detail type) is stored on all FF features as a string of 10 characters. Any dep-value shorter than 10 characters will have spaces padded on the left side to make the string 10 characters long. As a standard behavior, FME does not try to trim any values read from an FF file. Therefore, by setting this directive to YES, FME will trim those spaces from the left side of the dep-value.

Example:

FF_TRIM_DEP_ATTRIBUTE YES