NBCollectionMessage ClassIBM Integration Bus
NBCollectionMessage represents a message collection that can be passed between the nodes in a message flow. A message collection is a specialisation of an NBMessage.
Inheritance Hierarchy

OnlineSystem Object
  IBM.Broker.Plugin NBMessage
    IBM.Broker.Plugin NBCollectionMessage

Namespace: IBM.Broker.Plugin
Assembly: IBM.Broker.Plugin (in IBM.Broker.Plugin.dll) Version: 9.0.0.0
Syntax

public class NBCollectionMessage : NBMessage
Remarks

The last child of the root of the message is an element called "Collection" and has a Collection parser associated with it. The children of the Collection element are either name-value types that do not have an associated parser or are the root elements of Integration Bus message structures and will have an appropriate parser associated with them. In the case of structures created using this NBCollectionMessage class, the message roots are referred to as folders. The folders can be given any name you require and will be associated with a CollectionFolder parser. Typically, any name-value elements will preceed any folder element children of the Collection element. The following diagram illustrates the structure of a message collection.

              +------+
              | Root | (A)
              +--+---+
                 |
           +-----+------+
           | Collection | (A)
          +-----+------+
                 |
 +----------+----+-------+--------------+
 |          |            |              |
+--+--+    +--+--+    +----+----+    +----+----+
| nv1 |    | nv2 |    | folder1 |    | folder2 |
+-----+    +-----+    +----+----+    +----+----+
(B)        (B)       (C) |          (C) 
             +-----------+----------+                   
             |                      |    
       +-----+------+           +--------+
       | Properties |   - - -   | XMLNSC |
       +-----+------+    (D)    +---+----+
             |                      |
                                 +--+--+
                                 | msg |
                                 +--+--+
                                    |

The elements in the diagram marked (A), (B) and (C) are created by methods of the NBCollectionMessage class. Other elements, such as the children of the folder elements and their children in Properties and message body related children are created via their parent elements using the Create methods on the NBElement class. See CreateLastChild as an example. There may be other header elements at (D) in the diagram.

The elements marked (A) in the above diagram are created by the NBCollectionMessage constructor.

The elements marked (B) are created using the CreateNameValue() method of the NBCollectionMessage class.

The elements marked (C) are created using the CreateFolder() method of the NBCollectionMessage class.

See Also: "Working with Messages. Appendix A: Message Parsers - element definitions" in the infocenter.

See Also