org.knime.core.node

Class NodeDescription13Proxy

java.lang.Object

org.knime.core.node.NodeDescription

org.knime.core.node.NodeDescription13Proxy

final class NodeDescription13Proxy
extends NodeDescription

Implementation of NodeDescription for pre-2.0 node descriptions. It uses XMLBeans to extract the information from the XML file.
If assertions are enabled (see KNIMEConstants.ASSERTIONS_ENABLED it also checks the contents of the XML for against the XML schema and reports errors via the logger.

Since:

2.8

Author:

Thorsten Meinl, KNIME.com, Zurich, Switzerland

Constructor Summary

Constructors

Constructor and Description
NodeDescription13Proxy(Document doc) Creates a new proxy object using the given XML document.

Method Summary

Modifier and Type	Method and Description
String	getIconPath() Returns the path to the node's icon.
String	getInportDescription(int index) Returns a description for an input port.
String	getInportName(int index) Returns a name for an input port.
String	getInteractiveViewName() Returns the name of the interactive view if such a view exists.
String	getNodeName() Returns the name of this node.
String	getOutportDescription(int index) Returns a description for an output port.
String	getOutportName(int index) Returns a name for an output port.
NodeFactory.NodeType	getType() Returns the type of the node.
int	getViewCount() Returns the number of views which are listed in the meta information.
String	getViewDescription(int index) Returns a description for a view.
String	getViewName(int index) Returns the name for this node's view at the given index.
Element	getXMLDescription() The XML description can be used with the NodeFactoryHTMLCreator in order to get a converted HTML description of it, which fits the overall KNIME HTML style.
protected void	setIsDeprecated(boolean b) Flags this node as deprecated node.
(package private) boolean	validate() Validate against the XML Schema.

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

isDeprecated, stripXmlFragment

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeDescription13Proxy

public NodeDescription13Proxy(Document doc)
                       throws org.apache.xmlbeans.XmlException

Creates a new proxy object using the given XML document. If assertions are enabled (see KNIMEConstants.ASSERTIONS_ENABLED it also checks the contents of the XML for against the XML schema and reports errors via the logger.

Parameters:

doc - the XML document of the node description XML file

Throws:

org.apache.xmlbeans.XmlException - if something goes wrong while analyzing the XML structure

Method Detail

validate

final boolean validate()

Validate against the XML Schema. If violations are found they are reported via the logger as coding problems.

Returns:

true if the document is valid, false otherwise

getIconPath

public String getIconPath()

Returns the path to the node's icon. The path should be either absolute (with the root being the root of the classpath) or relative to the node factory's location.

Specified by:

getIconPath in class NodeDescription

Returns:

the path to the node icon, or null if no icon exists

See Also:

NodeFactory.getIcon()

getInportDescription

public String getInportDescription(int index)

Returns a description for an input port.

Specified by:

getInportDescription in class NodeDescription

Parameters:

index - the index of the input port, starting at 0

Returns:

an input port description or null if no description exists

See Also:

NodeFactory.getInportDescription(int)

getInportName

public String getInportName(int index)

Returns a name for an input port.

Specified by:

getInportName in class NodeDescription

Parameters:

index - the index of the input port, starting at 0

Returns:

an input port name or null if not name is known

See Also:

NodeFactory.getInportName(int)

getInteractiveViewName

public String getInteractiveViewName()

Returns the name of the interactive view if such a view exists. Otherwise null is returned.

Specified by:

getInteractiveViewName in class NodeDescription

Returns:

name of the interactive view or null

See Also:

NodeFactory.getInteractiveViewName()

getNodeName

public String getNodeName()

Returns the name of this node.

Specified by:

getNodeName in class NodeDescription

Returns:

the node's name or null if no name is known

See Also:

NodeFactory.getNodeName()

getOutportDescription

public String getOutportDescription(int index)

Returns a description for an output port.

Specified by:

getOutportDescription in class NodeDescription

Parameters:

index - the index of the output port, starting at 0

Returns:

an output port description or null if not description exists

See Also:

NodeFactory.getOutportDescription(int)

getOutportName

public String getOutportName(int index)

Returns a name for an output port.

Specified by:

getOutportName in class NodeDescription

Parameters:

index - the index of the output port, starting at 0

Returns:

an output port name or null if no name is known

See Also:

NodeFactory.getOutportName(int)

getType

public NodeFactory.NodeType getType()

Returns the type of the node.

Specified by:

getType in class NodeDescription

Returns:

the node's type

See Also:

NodeFactory.getType()

getViewCount

public int getViewCount()

Returns the number of views which are listed in the meta information.

Specified by:

getViewCount in class NodeDescription

Returns:

the number of views

getViewDescription

public String getViewDescription(int index)

Returns a description for a view.

Specified by:

getViewDescription in class NodeDescription

Parameters:

index - the index of the view, starting at 0

Returns:

a view description or null if no description exists

See Also:

NodeFactory.getViewDescription(int)

getViewName

public String getViewName(int index)

Returns the name for this node's view at the given index.

Specified by:

getViewName in class NodeDescription

Parameters:

index - the view index, starting at 0

Returns:

the view's name or null if no name is known

setIsDeprecated

protected void setIsDeprecated(boolean b)

Flags this node as deprecated node. Subclasses should override this method and modify the XML description accordingly.

Overrides:

setIsDeprecated in class NodeDescription

Parameters:

b - true if this node is node is deprecated, false otherwise

getXMLDescription

public Element getXMLDescription()

The XML description can be used with the NodeFactoryHTMLCreator in order to get a converted HTML description of it, which fits the overall KNIME HTML style.

Specified by:

getXMLDescription in class NodeDescription

Returns:

XML description of this node