0 ×

Rule Engine

StreamableKNIME Java Snippet Nodes version 4.0.0.v201906131505 by KNIME AG, Zurich, Switzerland

This node takes a list of user-defined rules and tries to match them to each row in the input table. If a rule matches, its outcome value is added into a new column. The first matching rule in order of definition determines the outcome.

Each rule is represented by a line. To add comments, start a line with // (comments can not be placed in the same line as a rule). Anything after // will not be interpreted as a rule. Rules consist of a condition part (antecedent), which must evaluate to true or false , and an outcome (consequent, after the => symbol) which is put into the new column if the rule matches.

The outcome of a rule may be any of the following: a string (between " or /), a number, a boolean constant, a reference to another column or the value of a flow variable value. The type of the outcome column is the common super type of all possible outcomes (including the rules that can never match). If no rule matches, the outcome is a missing value.

Columns are given by their name surrounded by $, numbers are given in the usual decimal representation. Note that strings must not contain (double-)quotes. Flow variables are represented by $${ TypeCharacterAndFlowVarName }$$ . The TypeCharacter should be 'D' for double (real) values, 'I' for integer values and 'S' for strings. You can insert column names or flow variables by hand or by clicking in the respective lists in the dialog.

The logical expressions can be grouped with parentheses. The precedence rules for them are the following: NOT binds most, AND, XOR and finally OR the least. Comparison operators always take precedence over logical connectives. All operators (and their names) are case-sensitive.

The ROWID represents the row key string, the ROWINDEX is a the index of the row (first row has 0 value), while ROWCOUNT stands for the number of rows in the table.

Some example rules (each should be in one line):

// This is a comment
$Col0$ > 0 => "Positive"
When the values in Col0 are greater than 0, we assign Positive to the result column value (if no previous rule matched).
$Col0$ = "Active" AND $Col1$ <= 5 => "Outlier"
You can combine conditions.
$Col0$ LIKE "Market Street*" AND 
    ($Col1$ IN ("married", "divorced") 
        OR $Col2$ > 40) => "Strange"
$Col0$ MATCHES $${SFlowVar0}$$ OR $$ROWINDEX$$ < $${IFlowVar1}$$ =>
    $Col0$
With parentheses you can combine multiple conditions. The result in the second case comes from one of the columns.
$Col0$ > 5 => $${SCol1}$$
The result can also come from a flow variable.

You can use either Ctrl+Space to insert predefined parts, or select them from the upper controls.

The following comparisons result true (other values are neither less, nor greater or equal to missing and NaN values):

  • ? =,<=,>= ?
  • NaN =,<=,>= NaN

Options

Rule Editor

Column List
Available columns, which can be used as variables in a rule.
Flow Variable List
Available flow variables, which can be used as variables in a rule.
Category
The operator categories.
Function
A list of valid operators in the selected category.
Description
Short help about the operator.
Expression
The rule editor. You can complete the expressions with Ctrl+Space. Each row represents a rule. A red background of the line signals an error and the left side of the editor then shows an error icon.
Append Column
Name of the newly appended column, which contains the outcome of the rules.
Replace Column
The column to replace

Input Ports

Any datatable

Output Ports

The input table with an additional column containing the outcome of the matching rule for each row.

Best Friends (Incoming)

Best Friends (Outgoing)

Workflows