ListBuilder
Output Ports
One feature is output for each unique combination of values of the attributes specified in the Group By parameter. Features output from this transformer have no geometry.
Parameters
Transformer
This parameter allows you to specify the attribute values on which to join the series of input features. One feature is output for each group created by selecting a Group By attribute. If no Group By attributes are specified, then a single feature is output and the number of elements in its list is equivalent to the number of features input into the ListBuilder.
No: This is the default behavior. Processing will only occur in this transformer once all input is present.
By Group: This transformer will process input groups in order. Changes of the value of the Group By parameter on the input stream will trigger batch processing on the currently accumulating group. This will improve overall speed if groups are large/complex, but could cause undesired behavior if input groups are not truly ordered.
Using Ordered input can provide performance gains in some scenarios, however, it is not always preferable, or even possible. Consider the following when using it, with both one- and two-input transformers.
Single Datasets/Feature Types: Are generally the optimal candidates for Ordered processing. If you know that the dataset is correctly ordered by the Group By attribute, using Input is Ordered By can improve performance, depending on the size and complexity of the data.
If the input is coming from a database, using ORDER BY in a SQL statement to have the database pre-order the data can be an extremely effective way to improve performance. Consider using a Database Readers with a SQL statement, or the SQLCreator transformer.
Multiple Datasets/Feature Types: Since all features matching a Group By value need to arrive before any features (of any feature type or dataset) belonging to the next group, using Ordering with multiple feature types is more complicated than processing a single feature type.
Multiple feature types and features from multiple datasets will not generally naturally occur in the correct order.
One approach is to send all features through a Sorter, sorting on the expected Group By attribute. The Sorter is a feature-holding transformer, collecting all input features, performing the sort, and then releasing them all. They can then be sent through an appropriate filter (TestFilter, AttributeFilter, GeometryFilter, or others), which are not feature-holding, and will release the features one at a time to the transformer using Input is Ordered By, now in the expected order.
The processing overhead of sorting and filtering may negate the performance gains you will get from using Input is Ordered By. In this case, using Group By without using Input is Ordered By may be the equivalent and simpler approach.
In all cases when using Input is Ordered By, if you are not sure that the incoming features are properly ordered, they should be sorted (if a single feature type), or sorted and then filtered (for more than one feature or geometry type).
As with many scenarios, testing different approaches in your workspace with your data is the only definitive way to identify performance gains.
Parameters
The features output from the ListBuilder have all of their attributes stored in the list identified by the name specified by this parameter.
All Attributes: Every attribute from all input features that created an output feature will be added to the list specified in List Name.
Selected Attributes: Only the attributes specified in the Selected Attributes parameter will be added to the list specified in List Name.
The attributes to be added to the list when Add To List is Selected Attributes.
Example
Suppose this transformer is used with no group-by attributes, and three features enter it with these attributes:
Feature 0: |
length = 7.3 kind = 'paved' |
Feature 1: |
length = 8.4 kind = ’smooth’ lanes = 2 |
Feature 2: |
length = 1.1 kind = ’rough’ |
then, presuming that the list name specified was somelist, a single feature with these attributes is output:
somelist{0}.length = 7.3
somelist{0}.kind = ’paved’
somelist{1}.length = 8.4
somelist{1}.kind = ’smooth’
somelist{1}.lanes = 2
somelist{2}.length = 1.1
somelist{2}.kind = ’rough’
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.
Transformer Categories
Search FME Knowledge Center
Search for samples and information about this transformer on the FME Knowledge Center.