FME Transformers: 2024.2
FME Transformers: 2024.2
GeometryPropertySetter
Sets selected geometry names or traits from feature attributes or constants.
Configuration
Input Ports
Input
Features with geometries.
Output Ports
Set
Features with newly set traits or geometry names.
Untouched
Features that were not modified by the transformer.
<Rejected> (Dynamic)
The dynamic <Rejected> port appears when a parameter is set to a non-literal value that might make processing impossible.
For example, if a numeric parameter such as Line Width, Count Start, or Decimal Places is set to an expression, attribute value, or user parameter, it is possible to pass in a non-numeric value that cannot be used. Decimal Places = Cat cannot be processed, so the feature will be output via this port.
Rejected features will have an fme_rejection_code attribute explaining the reason for rejection.
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
Geometry Part Selection
Geometry XQuery |
Use this parameter to isolate only a portion of the input geometry. 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. |
General
Property to Set |
|
Overwrite Existing Properties |
If a property is already present and this parameter is set to No, the geometry will not be modified. For example, if the geometry name is already set to House, then renaming as Residential will not apply if this parameter is set to No. |
Remove Attributes |
Determine whether the attributes will be removed from the feature after they have been set as geometry traits or not. Note This parameter is only valid if the Property to Set parameter is Traits From Attributes.
|
Traits from Attributes
Source Attributes |
Select the attributes from which to add new traits to the geometry. In particular, the name and value of the trait will match the name and value of the specified attribute. Note This parameter is only valid if the Property to Set parameter is Traits From Attributes.
|
Trait Counter
Count Output Trait |
Enter the name of the trait that will contain the results, and will appear on all the geometry parts that are selected by the Geometry XQuery. Note This parameter is only valid if the Property to Set parameter is Traits From Counter.
|
Counter Name |
Create separate sequences of numbers to be assigned, either by placing several GeometryPropertySetter transformers with each having a different counter name, or by choosing an attribute whose value will be used as the counter name as each feature passes through. (In effect, using an attribute to supply the GeometryPropertySetter name is like having a Group By option for the GeometryPropertySetter.) Note This parameter is only valid if the Property to Set parameter is Traits From Counter.
|
Count Start |
Specify a starting value for the counter. This is useful for applications where ranges of values have meanings in the problem domain. See Usage Notes in the Counter transformer for more tips. Note This parameter is only valid if the Property to Set parameter is Traits From Counter.
|
Count Scope |
Specify the scope of this counter:
Note This parameter is only valid if the Property to Set parameter is Traits From Counter.
|
Geometry Name
Geometry Name |
The text name or attribute containing the value for the name to be set on the geometry. |
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.
How to Set Parameter Values
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.
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
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:
|
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.
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 GeometryPropertySetter on the FME Community.
Keywords: GeometryTraitSetter GeometryNameSetter