Package org.knime.core.webui.node.impl

Class WebUINodeConfiguration.NodeOptionals

java.lang.Object
org.knime.core.webui.node.impl.WebUINodeConfiguration.NodeOptionals
Enclosing class:
WebUINodeConfiguration
public static final class WebUINodeConfiguration.NodeOptionals extends Object
The (final) build stage in which the ports and other "optional" configurations are defined.

  • Method Details

    • nodeType

      public WebUINodeConfiguration.NodeOptionals nodeType(org.knime.core.node.NodeFactory.NodeType nodeType)
      Sets the node type. This affects how the node is shown, e.g., Loop Start nodes are shown in light blue and form a small opening bracket that matches the way Loop End nodes are displayed.
      Parameters:
      nodeType - the node type
      Returns:
      this build stage

    • addInputTable

      public WebUINodeConfiguration.NodeOptionals addInputTable(String name, String description)
      Adds another input table to the node.
      Parameters:
      name - the name of the node's next input table
      description - the description of the node's next input table
      Returns:
      this build stage

    • addInputTable

      public WebUINodeConfiguration.NodeOptionals addInputTable(String name, String description, boolean configurable)
      Adds another input table to the node.
      Parameters:
      name - the name of the node's next input table
      description - the description of the node's next input table
      configurable - whether the port is configurable
      Returns:
      this build stage

    • addInputPort

      public WebUINodeConfiguration.NodeOptionals addInputPort(String name, org.knime.core.node.port.PortType type, String description)
      Adds another input port to the node.
      Parameters:
      name - the name of the node's next input port
      type - the type of the node's next input port
      description - the description of the node's next input port
      Returns:
      this build stage

    • addInputPort

      public WebUINodeConfiguration.NodeOptionals addInputPort(String name, org.knime.core.node.port.PortType type, String description, boolean configurable)
      Adds another input port to the node.
      Parameters:
      name - the name of the node's next input port
      type - the type of the node's next input port
      description - the description of the node's next input port
      configurable - whether the port is configurable
      Returns:
      this build stage

    • addOutputTable

      public WebUINodeConfiguration.NodeOptionals addOutputTable(String name, String description)
      Adds another output table to the node.
      Parameters:
      name - the name of the node's next output table
      description - the description of the node's next output table
      Returns:
      this build stage

    • addOutputTable

      public WebUINodeConfiguration.NodeOptionals addOutputTable(String name, String description, boolean configurable)
      Adds another output table to the node.
      Parameters:
      name - the name of the node's next output table
      description - the description of the node's next output table
      configurable - whether the port is configurable
      Returns:
      this build stage

    • addOutputPort

      public WebUINodeConfiguration.NodeOptionals addOutputPort(String name, org.knime.core.node.port.PortType type, String description)
      Adds another output port to the node.
      Parameters:
      name - the name of the node's next output port
      type - the type of the node's next output port
      description - the description of the node's next output port
      Returns:
      this build stage

    • addOutputPort

      public WebUINodeConfiguration.NodeOptionals addOutputPort(String name, org.knime.core.node.port.PortType type, String description, boolean configurable)
      Adds another output port to the node.
      Parameters:
      name - the name of the node's next output port
      type - the type of the node's next output port
      description - the description of the node's next output port
      configurable - whether the port is configurable
      Returns:
      this build stage

    • keywords

      public WebUINodeConfiguration.NodeOptionals keywords(String... keywords)
      Adds a list of keywords that are used/index for searching nodes. The list itself is not visible to the user.
      Parameters:
      keywords - List of keywords.
      Returns:
      this build stage

    • sinceVersion

      public WebUINodeConfiguration.NodeOptionals sinceVersion(int major, int minor, int revision)
      Specify since which KNIME AP version this node is available
      Parameters:
      major - major version
      minor - minor version
      revision - patch revision
      Returns:
      this build stage

    • build

      public WebUINodeConfiguration build()
      Returns:
      the built node