Extracts selected geometry names or traits to feature attributes.
Configuration
Input Ports
Input
Features with geometries.
Output Ports
Extracted
Features with newly set attributes based on geometry name or traits.
Unmatched
Features that were not queried.
<Rejected>
Features with no geometry properties are output through this port along with an additional attribute, fme_rejection_code, indicating the reason for rejection - MISSING_GEOMETRY_PROPERTY.
Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.
Parameters
General
|
Property to Extract |
|
| Geometry Part Selection XQuery |
Use this parameter if you want to isolate only a portion of the geometry passed in to the transformer. If no criteria are specified, the action will apply to the entire geometry at all levels. Selection can be based on structural location, geometry name, type, appearance information, traits, trait storage types, or definition reference. The syntax used is a restricted set of XQuery, where the return clause is fixed. The basic Geometry XQuery dialog allows you to construct simple selection queries by automatically writing the necessary query based on specified test clauses. Clicking the Switch to Advanced button opens the Advanced Editor, which allows you to type a query free-form, for more expressive queries. Note: Once you switch to Advanced mode, you will have to clear all parameters before you can return to Basic mode. A hierarchical geometry is represented as nodes of type geometry, with attributes containing information about traits, type, and name for each geometry. |
Extract Traits
|
Prefix Extracted Trait with Geometry Name |
Setting this parameter to Yes will prefix the extracted traits with the respective geometry’s name. If traits with the same name exist on multiple geometries, using this option will allow these traits to exist independently. |
|
Traits to Extract & Extract Traits as List |
The names of traits to extract from the geometry. If the Extract Traits as List checkbox is active, then the traits will be pushed up as a list attribute of the same name (even if just one trait present). If the Extract Traits as List checkbox is not active, then the trait will be set as an attribute, and if the trait is present on multiple parts of the geometry, one of the values will arbitrarily be the value associated with the new attribute. If no traits are specified, all traits on selected geometries will be pushed up as attributes (creating a list if the trait is present on multiple parts of the geometry and not otherwise). |
Output Attribute Name
| Geometry Name |
Name the attribute to contain the geometry name. If a hierarchical geometry is present, multiple geometry names will be extracted onto a list attribute of the same name. The default value for the Geometry Name Attribute is _geometry_name. This parameter is valid when the Property to Extract is set to Geometry Name. |
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click 
beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
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. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.
How to Set Parameter Values
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.
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.
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.
Content Types
| These functions manipulate and format strings. | |
|
Special Characters |
A set of control characters is available in the Text Editor. |
| Math functions are available in both editors. | |
| Date/Time Functions | Date and time functions are available in the Text Editor. |
| These operators are available in the Arithmetic Editor. | |
| These return primarily feature-specific values. | |
| FME and workspace-specific parameters may be used. | |
| Creating and Modifying User Parameters | Create your own editable parameters. |
Dialog Options - Tables
Transformers with table-style parameters have additional tools for populating and manipulating values.
Table Tools
|
Row Reordering
|
Enabled once you have clicked on a row item. Choices include:
|
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
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.
FME Community
The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.
Search for samples and information about this transformer on the FME Community.
Keywords: GeometryTraitExtractor GeometryTraitFetcher GeometryNameExtractor