com.ibm.broker.config.appdev

Class Node

  • java.lang.Object
    • com.ibm.broker.config.appdev.Node
    • Constructor Detail

      • Node

        public Node()
        This is the Node class which all the Nodes inherit from. This contains the properties which all nodes have
    • Method Detail

      • isUdpSupport

        public boolean isUdpSupport()
      • getLocation

        public Point getLocation()
        Gets the location of the node in the format "x,y"
        Returns:
        Point; location defined as "x,y"
      • setLocation

        public Node setLocation(Point location)
        Sets the location of the node in the format "x,y" setLocation(new Point(100,100))
        Parameters:
        location - Point
      • setLocation

        public Node setLocation(int x,
                                int y)
        Sets the location of the node in the format "x,y" setLocation(100,100)
        Parameters:
        x - int
        y - int
      • getLongDescription

        public java.lang.String getLongDescription()
        Gets the Long Description of the node
        Returns:
        String; The long description text
      • getShortDescription

        public java.lang.String getShortDescription()
        Gets the Short Description of the node
        Returns:
        String; The short description text
      • setLongDescription

        public Node setLongDescription(java.lang.String longDescription)
        Sets the Long Description of the node
        Parameters:
        longDescription - String; the long description string
      • setShortDescription

        public Node setShortDescription(java.lang.String shortDescription)
        Sets the Short Description of the node
        Parameters:
        shortDescription - String; the short description string
      • setProperty

        public Node setProperty(java.lang.String propertyName,
                                java.lang.String propertyValue)
        Allows the setting a node property directly by name and value
        Parameters:
        propertyName - String; A given node property
        propertyValue - String; A given node value
      • getPropertyNames

        public java.util.Enumeration<java.lang.String> getPropertyNames()
        Returns:
        Enumeration; returns the list of all know properties on this node
      • getMandatoryPropertyNames

        public java.util.Enumeration<java.lang.String> getMandatoryPropertyNames()
        Returns:
        Enumeration; returns the list of all know Mandatory properties on this node
      • getPropertyValue

        public java.lang.Object getPropertyValue(java.lang.String propertyName)
        Returns the property object on this node given the property name
        Parameters:
        propertyName - String; the property name
        Returns:
        Object; the property object
      • getPropertyDefaultValue

        public java.lang.Object getPropertyDefaultValue(java.lang.String propertyName)
        Returns the default value of the property object on this node given the property name
        Parameters:
        propertyName - String; the property name
        Returns:
        Object; the property object
      • findPropertyByName

        public NodeProperty findPropertyByName(java.lang.String propertyName)
        Finds the NodeProperty on the node of the given node property name
        Parameters:
        propertyName - String; the property name
        Returns:
        NodeProperty; returns the node property of the given property name. null is returned if the property has not been found.
      • setRotate

        public Node setRotate(Node.RotationKind rotate)
        Sets the orientation of this Node on the message flow canvas
        Parameters:
        rotate - RotateKind; the direction of the node
      • getRotate

        public Node.RotationKind getRotate()
        Gets the orientation fo this Node on the mesasge flow canvas
        Returns:
        RotateKind; the direction of the node
      • getInputTerminals

        public abstract InputTerminal[] getInputTerminals()
        Gets the full list of available InputTerminals for this Node
        Returns:
        InputTerminal[]
      • getOutputTerminals

        public abstract OutputTerminal[] getOutputTerminals()
        Gets the full list of available OutputTerminals for this Node
        Returns:
        OutputTerminal[]
      • getInputTerminal

        public InputTerminal getInputTerminal(java.lang.String terminalName)
        Gets the input terminal for the node. If the terminal is a dynamic terminal this will create the terminal and return it.
        Parameters:
        terminalName - String; the internal terminal name
        Returns:
        InputTerminal
      • getInputTerminal

        public InputTerminal getInputTerminal(java.lang.String terminalName,
                                              boolean dynamic)
      • getOutputTerminal

        public OutputTerminal getOutputTerminal(java.lang.String terminalName)
        Gets the output terminal for the node. If the terminal is a dynamic terminal this will create the terminal and return it.
        Parameters:
        terminalName - String; the internal terminal name
        Returns:
        an OutputTerminal
      • getOutputTerminal

        public OutputTerminal getOutputTerminal(java.lang.String terminalName,
                                                boolean dynamic)
      • getInstanceNodeProperties

        public 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.
        Returns:
        NodeProperty[] An array of simple NodeProperty
      • getNodeName

        public java.lang.String getNodeName()
        Gets the label name of this node
          MessageFlow mf1 = patternInstanceManager.getMessageFlow("MyFlowProject", "mf1.msgflow");
          Node inputMQNode = mf1.getNodeByName("My Input Node");
          inputMQNode.setNodeName("Renamed Input Node");
         
        Returns:
        String; the node name
      • setNodeName

        public Node setNodeName(java.lang.String nodeName)
        Sets the label name of this node. This allows you to rename a node.
        Parameters:
        nodeName - String; the given node name
        Returns:
        Node
      • getTypeName

        public abstract java.lang.String getTypeName()
        Gets the node type of this node
        Returns:
        String; the node type
      • addNsmapping

        public Node addNsmapping(NamespacePrefixMap nsmap)
        Adds a NamespacePrefixMap to the node
        Parameters:
        nsmap - NamespacePrefixMap to add to the node
      • removeNsmapping

        public Node removeNsmapping(NamespacePrefixMap nsmap)
        Removes a NamespacePrefixMap from the node. If the NamespacePrefixMap is not associated with this node, this method does nothing.
        Parameters:
        nsmap - The NamespacePrefixMap to remove
      • getNodePropertyTables

        public java.util.Vector<NodePropertyTable> getNodePropertyTables()
        Gets the complete list of tables associated with the Node
        Returns:
        Vector
      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object