SharedItemAdder

Categories

3D

Adds or replaces Appearances, Textures, Rasters, or Geometry Definitions in the internal FMELibrary.

Usage Notes

  • When adding Appearances or Textures, use style properties as described in the AppearanceStyler

Configuration

Input Ports

One of the following:

  • A raster feature, if Item To Add is Raster

  • A feature with any geometry except null, if Item to Add is Geometry Definition

  • A feature with null geometry and associated style information, if Item To Add is Appearance or Texture

Output Ports

Input features that were used to add an item to the internal FMELibrary are output through the Output port.

Input features that were not used to add an item to the internal FMELibrary.

Parameters

Item To Add

The type of shared item to add.
Insert Mode

When you pass in features, this transformer will be creating shared items. However, there are two ways these new shared items may be stored and used:

  • Add New Item: This is the simplest approach. With this option, a new shared item is created and stored in the internal FMELibrary. This new item is referenced by the selected geometry parts; references to previous items are dropped, leaving those items unchanged in the internal FMELibrary.
  • Replace Existing Item: This approach is powerful and may change many things in the dataset very efficiently. With this option, a new shared item is not created, but instead, the link to every shared item which is referenced by the selected Geometry Parts is followed, and each of those items is overwritten within the internal FMELibrary.

    This is reflected in two ways: First, all chosen geometry parts reflect the new shared item properties, even though they do not change how they reference items. Second, a more subtle effect is that all geometry parts, on all active features (even those features not passing through this factory) that refer to the overwritten shared item will immediately see the new values as well.
Shared Item ID To Replace

When replacing existing items, this parameter specifies the name of the attribute containing the shared item ID to replace.
Shared Item ID Attribute

When adding new items, this parameter specifies the name of the attribute that will store the ID of the added shared item.

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.

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.

Dialog Options - Tables

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.

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.