Package org.knime.core.webui.node.view

Class NodeViewManager

java.lang.Object
org.knime.core.webui.node.view.NodeViewManager
public final class NodeViewManager extends Object
Manages (web-ui) node view instances and provides associated functionality.
Since:
4.5
Author:
Martin Horn, KNIME GmbH, Konstanz, Germany, Marc Bux, KNIME GmbH, Berlin, Germany

  • Method Details

    • getInstance

      public static NodeViewManager getInstance()
      Returns the singleton instance for this class.
      Returns:
      the singleton instance

    • hasNodeView

      public static boolean hasNodeView(org.knime.core.node.workflow.NodeContainer nc)
      Parameters:
      nc - the node container to check
      Returns:
      whether the node container provides a NodeView

    • updateNodeViewSettings

      public void updateNodeViewSettings(org.knime.core.node.workflow.NativeNodeContainer nnc) throws org.knime.core.node.InvalidSettingsException
      Updates the view settings of a already created node view (i.e. a node view that has already been requested via getNodeView(NodeContainer) at least once). Updating the view settings means to get the current node settings from the node and provide them to the view (via NodeView.loadValidatedSettingsFrom(org.knime.core.node.NodeSettingsRO). NOTE: The settings (values) being passed to the node view are already combined with upstream flow variables (in case settings are overwritten by flow variables).
      Parameters:
      nnc - the node container to update the node view for
      Throws:
      org.knime.core.node.InvalidSettingsException - if settings couldn't be updated
      IllegalArgumentException - if the passed node container does not provide a node view

    • getDataServiceManager

      public DataServiceManager<NodeWrapper> getDataServiceManager()
      Returns:
      the DataServiceManager instance

    • getPageResourceManager

      public PageResourceManager<NodeWrapper> getPageResourceManager()
      Returns:
      the PageResourceManager instance

    • getTableViewManager

      public TableViewManager<NodeWrapper> getTableViewManager()
      Returns:
      the TableViewManager instance

    • canBeUsedInReport

      public boolean canBeUsedInReport(org.knime.core.node.workflow.NativeNodeContainer nnc)
      Parameters:
      nnc -
      Returns:
      see NodeView.canBeUsedInReport()

    • getInputDataTableSpecIfTableView

      public Optional<org.knime.core.data.DataTableSpec> getInputDataTableSpecIfTableView(org.knime.core.node.workflow.NodeContainer nc)
      Parameters:
      nc -
      Returns:
      the DataTableSpec if the node view is also a TableView otherwise an empty optional

    • validateSettings

      public void validateSettings(org.knime.core.node.workflow.NodeContainer nc, org.knime.core.node.NodeSettings viewSettings) throws org.knime.core.node.InvalidSettingsException
      Calls NodeView.validateSettings(org.knime.core.node.NodeSettingsRO).
      Parameters:
      nc -
      viewSettings -
      Throws:
      org.knime.core.node.InvalidSettingsException

    • getDefaultPageFormat

      public PageFormat getDefaultPageFormat(org.knime.core.node.workflow.NodeContainer nc)
      Parameters:
      nc -
      Returns:
      see NodeView.getDefaultPageFormat()