public abstract class Node
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
Each Node instance is the logical representation of an IBM Integration Bus node.
It does not imply an association with a message flow; Node instances can be created and modified before they are added to a MessageFlow or connected with another node.
The Node class is abstract, so it is not possible to create concrete instances of the Node type. Use the classes inside the com.ibm.broker.config.appdev.nodes package to instantiate known node types, or use the GenericNode class to instantiate all other node types, including user defined nodes.
Node classes are clonable so you can create copies of Node classes.
MQInputNode mqin = new MQInputNode(); mqin.setNodeName("The Input Node"); mqin.setQueueName("INPUTQ"); mqin.setLogicalOrder(false); MQInputNode mqin3 = (MQInputNode) mqin.clone(); mqin3.setNodeName("Copy of The Input Node"); mf.addNode(mqin3);
Here is an example that shows how to create MQInput and MQOutput nodes and wire them together:
Node myMQInput = new MQInputNode("input from queue"); Node myMQOutput = new MQOutputNode("output to queue"); mf1.connect(myMQInput.getOutputTerminal("out"), myMQOutput.getInputTerminal("in"));
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ xxxxx.x 2010-07-27 HDMPL creation xxxxx.x 2010-08-10 dstorey v7.0.0.2 Release xxxxx.x 2011-07-06 dstorey v8.0.0.0 Release xxxxx.x 2012-10-16 tdolby v8.0.0.2 Release
Modifier and Type | Class and Description |
---|---|
static class |
Node.RotationKind |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
protected boolean |
dynamicInputTerminals |
protected boolean |
dynamicOutputTerminals |
protected java.util.Vector<NodePropertyTable> |
nodePropertyTables |
protected boolean |
udpSupport |
Constructor and Description |
---|
Node()
This is the Node class which all the Nodes inherit from.
|
Modifier and Type | Method and Description |
---|---|
protected Node |
addAdditionalProperty(java.lang.String propertyName,
java.lang.String propertyValue)
Allows the setting a node property directly by name and value when the property isn't known
|
protected Node |
addMonitorEvent(com.ibm.broker.config.appdev.MonitorEvent monitorEvent)
Adds a MonitorEvent to the node
|
Node |
addNsmapping(NamespacePrefixMap nsmap)
Adds a NamespacePrefixMap to the node
|
java.lang.Object |
clone() |
protected InputTerminal |
createNewInputTerminal(java.lang.String name) |
protected InputTerminal |
createNewInputTerminal(java.lang.String name,
boolean dynamic) |
protected OutputTerminal |
createNewOutputTerminal(java.lang.String name) |
protected OutputTerminal |
createNewOutputTerminal(java.lang.String name,
boolean dynamic) |
NodeProperty |
findPropertyByName(java.lang.String propertyName)
Finds the NodeProperty on the node of the given node property name
|
protected NodeProperty[] |
getAllNodeProperties()
Returns the complete set of properties for this, including dynamic ones added to IBM-defiend nodes
|
InputTerminal |
getInputTerminal(java.lang.String terminalName)
Gets the input terminal for the node.
|
InputTerminal |
getInputTerminal(java.lang.String terminalName,
boolean dynamic) |
abstract InputTerminal[] |
getInputTerminals()
Gets the full list of available InputTerminals for this Node
|
NodeProperty[] |
getInstanceNodeProperties()
Returns the list of the simple properties which are defined on this node instance
The actual node instance values are set for these node properties.
|
Point |
getLocation()
Gets the location of the node in the format "x,y"
|
java.lang.String |
getLongDescription()
Gets the Long Description of the node
|
java.util.Enumeration<java.lang.String> |
getMandatoryPropertyNames() |
protected java.util.Vector<com.ibm.broker.config.appdev.MonitorEvent> |
getMonitorEvents() |
protected java.lang.String |
getNodeId() |
java.lang.String |
getNodeName()
Gets the label name of this node
|
protected NodeProperty[] |
getNodeProperties()
Returns the list of simple properties which are available to set on this node
No instance values are set here.
|
java.util.Vector<NodePropertyTable> |
getNodePropertyTables()
Gets the complete list of tables associated with the Node
|
java.util.Vector<NamespacePrefixMap> |
getNsmappingtables() |
OutputTerminal |
getOutputTerminal(java.lang.String terminalName)
Gets the output terminal for the node.
|
OutputTerminal |
getOutputTerminal(java.lang.String terminalName,
boolean dynamic) |
abstract OutputTerminal[] |
getOutputTerminals()
Gets the full list of available OutputTerminals for this Node
|
java.lang.Object |
getPropertyDefaultValue(java.lang.String propertyName)
Returns the default value of the property object on this node given the property name
|
java.util.Enumeration<java.lang.String> |
getPropertyNames() |
java.lang.Object |
getPropertyValue(java.lang.String propertyName)
Returns the property object on this node given the property name
|
Node.RotationKind |
getRotate()
Gets the orientation fo this Node on the mesasge flow canvas
|
java.lang.String |
getShortDescription()
Gets the Short Description of the node
|
abstract java.lang.String |
getTypeName()
Gets the node type of this node
|
protected java.lang.String |
getUUID() |
boolean |
isUdpSupport() |
protected Node |
removeMonitorEvent(com.ibm.broker.config.appdev.MonitorEvent monitorEvent)
Removes a monitorEvent from the node.
|
Node |
removeNsmapping(NamespacePrefixMap nsmap)
Removes a NamespacePrefixMap from the node.
|
Node |
setLocation(int x,
int y)
Sets the location of the node in the format "x,y"
setLocation(100,100)
|
Node |
setLocation(Point location)
Sets the location of the node in the format "x,y"
setLocation(new Point(100,100))
|
Node |
setLongDescription(java.lang.String longDescription)
Sets the Long Description of the node
|
protected Node |
setMonitorEvents(java.util.Vector<com.ibm.broker.config.appdev.MonitorEvent> monitoring) |
protected Node |
setNodeId(java.lang.String nodeId) |
Node |
setNodeName(java.lang.String nodeName)
Sets the label name of this node.
|
Node |
setNsmappingtables(java.util.Vector<NamespacePrefixMap> nsmappingtable) |
Node |
setProperty(java.lang.String propertyName,
java.lang.String propertyValue)
Allows the setting a node property directly by name and value
|
Node |
setRotate(Node.RotationKind rotate)
Sets the orientation of this Node on the message flow canvas
|
Node |
setShortDescription(java.lang.String shortDescription)
Sets the Short Description of the node
|
java.lang.String |
toString() |
public static final java.lang.String copyright
protected java.util.Vector<NodePropertyTable> nodePropertyTables
protected boolean dynamicInputTerminals
protected boolean dynamicOutputTerminals
protected boolean udpSupport
public Node()
protected java.lang.String getUUID()
protected java.lang.String getNodeId()
protected Node setNodeId(java.lang.String nodeId)
public boolean isUdpSupport()
public Point getLocation()
public Node setLocation(Point location)
location
- Pointpublic Node setLocation(int x, int y)
x
- inty
- intpublic java.lang.String getLongDescription()
public java.lang.String getShortDescription()
public Node setLongDescription(java.lang.String longDescription)
longDescription
- String; the long description stringpublic Node setShortDescription(java.lang.String shortDescription)
shortDescription
- String; the short description stringpublic Node setProperty(java.lang.String propertyName, java.lang.String propertyValue)
propertyName
- String; A given node propertypropertyValue
- String; A given node valueprotected Node addAdditionalProperty(java.lang.String propertyName, java.lang.String propertyValue)
propertyName
- A given node propertypropertyValue
- A given node valueprotected NodeProperty[] getAllNodeProperties()
public java.util.Enumeration<java.lang.String> getPropertyNames()
public java.util.Enumeration<java.lang.String> getMandatoryPropertyNames()
public java.lang.Object getPropertyValue(java.lang.String propertyName)
propertyName
- String; the property namepublic java.lang.Object getPropertyDefaultValue(java.lang.String propertyName)
propertyName
- String; the property namepublic NodeProperty findPropertyByName(java.lang.String propertyName)
propertyName
- String; the property namepublic Node setRotate(Node.RotationKind rotate)
rotate
- RotateKind; the direction of the nodepublic Node.RotationKind getRotate()
public abstract InputTerminal[] getInputTerminals()
public abstract OutputTerminal[] getOutputTerminals()
public InputTerminal getInputTerminal(java.lang.String terminalName)
terminalName
- String; the internal terminal namepublic InputTerminal getInputTerminal(java.lang.String terminalName, boolean dynamic)
public OutputTerminal getOutputTerminal(java.lang.String terminalName)
terminalName
- String; the internal terminal namepublic OutputTerminal getOutputTerminal(java.lang.String terminalName, boolean dynamic)
protected OutputTerminal createNewOutputTerminal(java.lang.String name)
protected OutputTerminal createNewOutputTerminal(java.lang.String name, boolean dynamic)
protected InputTerminal createNewInputTerminal(java.lang.String name)
protected InputTerminal createNewInputTerminal(java.lang.String name, boolean dynamic)
protected NodeProperty[] getNodeProperties()
public NodeProperty[] getInstanceNodeProperties()
public java.lang.String getNodeName()
MessageFlow mf1 = patternInstanceManager.getMessageFlow("MyFlowProject", "mf1.msgflow"); Node inputMQNode = mf1.getNodeByName("My Input Node"); inputMQNode.setNodeName("Renamed Input Node");
public Node setNodeName(java.lang.String nodeName)
nodeName
- String; the given node namepublic abstract java.lang.String getTypeName()
protected java.util.Vector<com.ibm.broker.config.appdev.MonitorEvent> getMonitorEvents()
protected Node setMonitorEvents(java.util.Vector<com.ibm.broker.config.appdev.MonitorEvent> monitoring)
public java.util.Vector<NamespacePrefixMap> getNsmappingtables()
public Node setNsmappingtables(java.util.Vector<NamespacePrefixMap> nsmappingtable)
public Node addNsmapping(NamespacePrefixMap nsmap)
nsmap
- NamespacePrefixMap to add to the nodepublic Node removeNsmapping(NamespacePrefixMap nsmap)
nsmap
- The NamespacePrefixMap to removeprotected Node addMonitorEvent(com.ibm.broker.config.appdev.MonitorEvent monitorEvent)
monitorEvent
- Monitor to add to the nodeprotected Node removeMonitorEvent(com.ibm.broker.config.appdev.MonitorEvent monitorEvent)
monitorEvent
- The monitorEvent to removepublic java.util.Vector<NodePropertyTable> getNodePropertyTables()
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object