ReorderList

MLModule

author	Lennart Tautz
package	FMEwork/ReleaseMeVis
dll	MLReorderList
definition	MLReorderList.def
see also	Sublist, SplitList, MergeLists, DecomposeBaseList, ReverseList
keywords	base, list, object, sort, order, reorder, reverse, inverse, select

Purpose

This module reorders a Base list based on indices.

Usage

Connect a Base list (inList), specify the new order of items (New List Order) and press Update.

Windows

Default Panel

Input Fields

inList

name: inList, type: MLBase

A Base list.

Output Fields

outList

name: outList, type: MLBase

The reordered Base list.

Parameter Fields

Field Index

[]: Trigger	Update: Trigger
Clear: Trigger
doNotClearOnFailedUpdate: Bool
Has Valid Output: Bool
New List Order: String
On Input Change Behavior: Enum
Status Code: Enum
Status Message: String

Visible Fields

Update

name: update, type: Trigger

Initiates update of all output field values.

Clear

name: clear, type: Trigger

Clears all output field values to a clean initial state.

On Input Change Behavior

name: onInputChangeBehavior, type: Enum, default: Clear, deprecated name: shouldUpdateAutomatically,shouldAutoUpdate

Declares how the module should react if a value of an input field changes.

Values:

Title	Name	Deprecated Name
​Update	​Update	​TRUE
​Clear	​Clear	​FALSE

Status Code

name: statusCode, type: Enum, persistent: no

Reflects module’s status (successful or failed computations) as one of some predefined enumeration values.

Values:

Title	Name
​Ok	​Ok
​Invalid input object	​Invalid input object
​Invalid input parameter	​Invalid input parameter
​Internal error	​Internal error

Status Message

name: statusMessage, type: String, persistent: no

Gives additional, detailed information about status code as human-readable message.

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

Indicates validity of output field values (success of computation).

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

New List Order

name: inNewListOrder, type: String

This parameter contains a list of indices describing the new item order.

The list consists of space- or comma-separated indices. Additionally, special syntax allows complex orders without having the user to create the list manually. The two constants N and H contain the maximum and middle index of the list, respectively. In the following, A, B and C represent arbitrary positive (including zero) integer numbers.

An index entry A:B will expand to the indices ranging from A to B (inclusive), while an index entry A:B:C will expand to the indices ranging from A to B with an increment of C between indices. Note that C is always positive, as the direction is determined from A and B itself. An index entry A*B will repeat the index B A times.

Hidden Fields

doNotClearOnFailedUpdate

name: doNotClearOnFailedUpdate, type: Bool, persistent: no

Prevents automated clear after update failed. This does not affect status fields. It enables the developer to analyze module’s state after failure.