Package org.knime.core.webui.node.dialog

Interface VariableSettingsRO

All Known Subinterfaces:
NodeAndVariableSettingsRO
All Known Implementing Classes:
VariableSettings
public interface VariableSettingsRO
Gives access to the variable settings tree. Infos on the settings which are exposed as or controlled by flow variables.
Author:
Martin Horn, KNIME GmbH, Konstanz, Germany

  • Method Details

    • getVariableSettingsIterable

      Iterable<String> getVariableSettingsIterable()
      Returns:
      an iterable over all the settings keys at this level

    • isVariableSetting

      boolean isVariableSetting(String key)
      Whether the setting for the given key is a 'leaf' in the variable settings tree. I.e. getUsedVariable(String) and getExposedVariable(String) can be called without them throwing an InvalidSettingsException . If false getVariableSettings(String) can be used to further traverse the variable settings tree.
      Parameters:
      key -
      Returns:
      true if the setting for the key is a variable setting

    • getVariableSettings

      VariableSettingsRO getVariableSettings(String key) throws org.knime.core.node.InvalidSettingsException
      Parameters:
      key -
      Returns:
      the variable settings subtree for the given key
      Throws:
      org.knime.core.node.InvalidSettingsException - if there is no variable settings subtree for the given key

    • getUsedVariable

      String getUsedVariable(String key) throws org.knime.core.node.InvalidSettingsException
      Parameters:
      key -
      Returns:
      the name of the variable used or null if none is set
      Throws:
      org.knime.core.node.InvalidSettingsException - if there no variable setting for the given key

    • getExposedVariable

      String getExposedVariable(String key) throws org.knime.core.node.InvalidSettingsException
      Parameters:
      key -
      Returns:
      the name of the variable exposed or null if none is set
      Throws:
      org.knime.core.node.InvalidSettingsException - if there no variable setting for the given key