FME Transformers: 2024.2

Categories
Data Quality

Data Quality

Database

Database

Filters and Joins

Filters and Joins

Categories
Data Quality

Data Quality

Database

Database

Filters and Joins

Filters and Joins

FeatureTypeFilter

Routes input features to different output ports based on their original feature type. This transformer is especially useful when you have combined several input features for a particular operation (for example, a Clipper) but want to filter them afterwards in order to route them differently.

Usage Notes

  • You can dynamically create new destination feature types that connect to each output port created by the FeatureTypeFilter. In the FME Workbench canvas, right-click on the FeatureTypeFilter transformer and select Auto Connect. For more information, see Auto Connect to Destination Feature Types in the FME Workbench help.
  • Output feature order may be controlled with the Advanced > Preserve Feature Order parameter.

Configuration

Output Ports

An output port is created for every connected feature type specified in the Feature Type Names parameter.

If a feature was generated dynamically by this workspace, or has gone through another transformer that caused it to lose its feature type, then it will exit through the <Blank> port.

If a feature has a feature type that is not specified in the Feature Type Names parameter, then it will exit through the <Unfiltered> port.

Parameters

After connecting feature types to the Input port of the FeatureTypeFilter, open the transformer parameters and click the Update button at the bottom right. (You can also type names in the Feature Type Names field.) FME analyzes the workspace and determines the possible input feature types.

The Update button is enabled only if you are in the main tab and have an input feature type attached to the FeatureTypeFilter transformer. The Update button will then read the feature types on the connected reader and automatically populate the Feature Type Names list with those values.

Click Update again and FME creates the corresponding output ports for every new connection.

Note  Note that when you remove a connection and update the FeatureTypeFilter, the corresponding output port is removed, as well as any connections made from that port. To avoid this, proceed with caution.

Preserve Feature Order

This parameter controls the order in which features exit a transformer.

When a transformer has more than one output port, features usually exit one port at a time. At times, it may be useful to keep the order that features arrived in, switching from port to port as necessary. This allows feature order to be preserved, though at a potential cost in processing efficiency.

Select a method for feature ordering.

Per Output Port (Default)

Only preserve the input order of features as they occur within the group of features exiting a given output port.

All features exiting an output port retain their ordering relative to each other (within the group), but not relative to features exiting other output ports.

This option is generally the most efficient, where large chunks of features will exit an output port together (taking advantage of bulk mode).

As features exiting different output ports may not be strictly output in the order they arrived, output ordering may be unpredictable.

Across Output Ports

Strictly preserve the input order of features, regardless of which output port they exit. Features will be output singly in the same order they arrived, switching from port to port as necessary. This option is generally less efficient as the processing gains of bulk mode are less likely to apply - however, feature order is predictable.

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

String Functions

These functions manipulate and format strings.

Special Characters

 A set of control characters is available in the Text Editor.

Math Functions

Math functions are available in both editors.
Date/Time Functions Date and time functions are available in the Text Editor.

Math Operators

These operators are available in the Arithmetic Editor.

FME Feature Functions

These return primarily feature-specific values.

FME Parameters

FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters Create your own editable parameters.

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

  • Add a row
  • Remove a row
  • Move current row up one
  • Move current row down one
  • Move current row to top
  • Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

  • Cut a row - delete and copy to clipboard
  • Copy a row to the clipboard
  • Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

For more information, see Transformer Parameter Menu Options.

FME Community

The FME Community has a wealth of FME knowledge with over 20,000 active members worldwide. Get help with FME, share knowledge, and connect with users globally.

Search for all results about the FeatureTypeFilter on the FME Community.