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

Class WebUINodeFactory<M extends org.knime.core.node.NodeModel>

java.lang.Object

org.knime.core.node.NodeFactory<M>

org.knime.core.webui.node.impl.WebUINodeFactory<M>

Type Parameters:

M - the type of the WebUINodeModel created by this factory

All Implemented Interfaces:

NodeDialogFactory

public abstract class WebUINodeFactory<M extends org.knime.core.node.NodeModel>
extends org.knime.core.node.NodeFactory<M>
implements NodeDialogFactory

A convenience class for simple WebUI nodes, i.e., nodes making use of the DefaultNodeSettings and DefaultNodeDialog classes. For an exemplary implementation, see org.knime.core.webui.node.dialog.impl.TestWebUINodeFactory in org.knime.core.ui.tests.

Author:

Marc Bux, KNIME GmbH, Berlin, Germany

Nested Class Summary

Nested classes/interfaces inherited from class org.knime.core.node.NodeFactory

org.knime.core.node.NodeFactory.NodeType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebUINodeFactory(WebUINodeConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
protected final org.knime.core.node.NodeDescription	createNodeDescription()
static org.knime.core.node.NodeDescription	createNodeDescription(String name, String icon, PortDescription[] inPortDescriptions, PortDescription[] outPortDescriptions, String shortDescription, String fullDescription, Class<? extends DefaultNodeSettings> modelSettingsClass, Class<? extends DefaultNodeSettings> viewSettingsClass, String viewDescription, org.knime.core.node.NodeFactory.NodeType type, String[] keywords)
static org.knime.core.node.NodeDescription	createNodeDescription(String name, String icon, PortDescription[] inPortDescriptions, PortDescription[] outPortDescriptions, String shortDescription, String fullDescription, Class<? extends DefaultNodeSettings> modelSettingsClass, Class<? extends DefaultNodeSettings> viewSettingsClass, String viewDescription, org.knime.core.node.NodeFactory.NodeType type, String[] keywords, org.knime.core.util.Version sinceVersion)
static org.knime.core.node.NodeDescription	createNodeDescription(WebUINodeConfiguration configuration)
final NodeDialog	createNodeDialog()	Creates a new node dialog instance.
protected final org.knime.core.node.NodeDialogPane	createNodeDialogPane()
final org.knime.core.node.NodeView<M>	createNodeView(int i, M nodeModel)
final int	getNrNodeViews()
final boolean	hasDialog()

Methods inherited from class org.knime.core.node.NodeFactory

addLoadedFactory, createAbstractNodeView, createNodeDialogPane, createNodeModel, createNodeModel, createNodeModel, getDefaultIcon, getFactoryId, getIcon, getInportDescription, getInportName, getInteractiveViewName, getKeywords, getLoadedNodeFactories, getNodeName, getNodeViewName, getOutportDescription, getOutportName, getPropertiesInputStream, getType, getViewDescription, getXMLDescription, init, isDeprecated, isLazilyInitialized, loadAdditionalFactorySettings, saveAdditionalFactorySettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.knime.core.webui.node.dialog.NodeDialogFactory

hasNodeDialog

Constructor Details

WebUINodeFactory

protected WebUINodeFactory(WebUINodeConfiguration configuration)

Parameters:

configuration - the WebUINodeConfiguration for this factory

Method Details

createNodeDescription

protected final org.knime.core.node.NodeDescription createNodeDescription()
                                                                   throws SAXException,
IOException,
org.apache.xmlbeans.XmlException

Overrides:

createNodeDescription in class org.knime.core.node.NodeFactory<M extends org.knime.core.node.NodeModel>

Throws:

SAXException

IOException

org.apache.xmlbeans.XmlException

createNodeDescription

public static org.knime.core.node.NodeDescription createNodeDescription(WebUINodeConfiguration configuration)

Parameters:

configuration - the config to create the node description for

Returns:

a new NodeDescription-instance derived from the given WebUINodeConfiguration

createNodeDescription

public static org.knime.core.node.NodeDescription createNodeDescription(String name,
 String icon,
 PortDescription[] inPortDescriptions,
 PortDescription[] outPortDescriptions,
 String shortDescription,
 String fullDescription,
 Class<? extends DefaultNodeSettings> modelSettingsClass,
 Class<? extends DefaultNodeSettings> viewSettingsClass,
 String viewDescription,
 org.knime.core.node.NodeFactory.NodeType type,
 String[] keywords)

Parameters:

name - the name of the node

icon - relative path to the node icon

inPortDescriptions - the descriptions of the node's input ports

outPortDescriptions - the descriptions of the node's output ports

shortDescription - the short node description

fullDescription - the full node description

modelSettingsClass - the type of the model settings, or null, if the node has no model settings

viewSettingsClass - the type of the view settings, or null, if the node has no view settings

viewDescription - the view description, or null, if the node has no view

type - the type of the node, or null, if it should be determined automatically

keywords - the keywords for serach, or null.

Returns:

a description for this node

createNodeDescription

public static org.knime.core.node.NodeDescription createNodeDescription(String name,
 String icon,
 PortDescription[] inPortDescriptions,
 PortDescription[] outPortDescriptions,
 String shortDescription,
 String fullDescription,
 Class<? extends DefaultNodeSettings> modelSettingsClass,
 Class<? extends DefaultNodeSettings> viewSettingsClass,
 String viewDescription,
 org.knime.core.node.NodeFactory.NodeType type,
 String[] keywords,
 org.knime.core.util.Version sinceVersion)

Parameters:

name - the name of the node

icon - relative path to the node icon

inPortDescriptions - the descriptions of the node's input ports

outPortDescriptions - the descriptions of the node's output ports

shortDescription - the short node description

fullDescription - the full node description

modelSettingsClass - the type of the model settings, or null, if the node has no model settings

viewSettingsClass - the type of the view settings, or null, if the node has no view settings

viewDescription - the view description, or null, if the node has no view

type - the type of the node, or null, if it should be determined automatically

keywords - the keywords for search, or null.

sinceVersion - the KNIME AP version since which this node is available, or null

Returns:

a description for this node

getNrNodeViews

public final int getNrNodeViews()

Specified by:

getNrNodeViews in class org.knime.core.node.NodeFactory<M extends org.knime.core.node.NodeModel>

createNodeView

public final org.knime.core.node.NodeView<M> createNodeView(int i,
 M nodeModel)

Specified by:

createNodeView in class org.knime.core.node.NodeFactory<M extends org.knime.core.node.NodeModel>

hasDialog

public final boolean hasDialog()

Specified by:

hasDialog in class org.knime.core.node.NodeFactory<M extends org.knime.core.node.NodeModel>

createNodeDialog

public final NodeDialog createNodeDialog()

Description copied from interface: NodeDialogFactory

Creates a new node dialog instance. It is guaranteed that a NodeContext is available when the method is called.

Specified by:

createNodeDialog in interface NodeDialogFactory

Returns:

a new node dialog instance

createNodeDialogPane

protected final org.knime.core.node.NodeDialogPane createNodeDialogPane()

Specified by:

createNodeDialogPane in class org.knime.core.node.NodeFactory<M extends org.knime.core.node.NodeModel>