NodeDialogPane.createFlowVariableModel deprecation warning

qqilihq · January 11, 2021, 1:31pm

org.knime.core.node.NodeDialogPane.createFlowVariableModel(String, Type)

Above mentioned function triggers a deprecation warning on more-recent KNIME APIs (I use 4.1), due to FlowVariable.Type being deprecated.

Through which non-deprecated counterpart is this function call supposed to be replaced?

– Philipp

gab1one · January 11, 2021, 1:40pm

Hi Philipp,

The javadoc should have pointed you to the correct method, take a look here:

github.com

knime/knime-core/blob/3e323a792d75a92e665b4939abebd06b00ded2d0/org.knime.core/src/eclipse/org/knime/core/node/NodeDialogPane.java#L1425


 * for a hierarchical settings object.
 * This can serve two purposes:
 * 1) replace the actual value in the settings object by the value of
 *    the variable
 * 2) and/or put the current value of the settings object into the
 *    specified variable.
 *
 * @param keys hierarchy of keys of corresponding settings object
 * @param type of variable/settings object
 * @return new FlowVariableModel which is already registered
 * @deprecated use {@link NodeDialogPane#createFlowVariableModel(String[], VariableType)} instead
 */
@Deprecated
public FlowVariableModel createFlowVariableModel(
        final String[] keys, final FlowVariable.Type type) {
    FlowVariableModel wvm = new FlowVariableModel(this, keys, type);
    m_flowVariablesModelList.add(wvm);
    wvm.addChangeListener(e -> {
            m_flowVariablesModelChanged = true;
            updateFlowVariablesOverwriteWarning();
    });

it tells you to use the new method:

github.com

knime/knime-core/blob/3e323a792d75a92e665b4939abebd06b00ded2d0/org.knime.core/src/eclipse/org/knime/core/node/NodeDialogPane.java#L1410


 * 1) replace the actual value in the settings object by the value of
 *    the variable
 * 2) and/or put the current value of the settings object into the
 *    specified variable.
 * @param key of corresponding settings object
 * @param type of variable/settings object
 * @return new FlowVariableModel which is already registered
 *
 * @since 4.2
 */
public FlowVariableModel createFlowVariableModel(final String key, final VariableType<?> type) {
    return createFlowVariableModel(new String[] {key}, type);
}
/** Create model and register a new variable for a specific settings entry
 * for a hierarchical settings object.
 * This can serve two purposes:
 * 1) replace the actual value in the settings object by the value of
 *    the variable
 * 2) and/or put the current value of the settings object into the
 *    specified variable.

The deprecation was done to add support for the new extendible flow variable types.

best,
Gabriel

qqilihq · January 11, 2021, 1:45pm

Ok, so this is only in 4.2.

Thx.

system · January 18, 2021, 1:45pm

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.