Apama 10.15.1 | Connecting Apama Applications to External Components | Standard IAF Plug-ins | Codec IAF Plug-ins | The XML codec IAF plug-in | Specifying XML codec properties | Downstream node order suffix properties
 
Downstream node order suffix properties
generateTwinOrderSuffix — If true, all field names for text, CDATA and element nodes are appended with "", "[2]", "[3]", and so on. The number specifies the position of this node relative to 'twins', that is, nodes of the same type and name. These order suffixes provide a partial order for the XML nodes. Note that the first child node with a given name is defined to have no suffix (rather than an explicit "[1]"), to improve readability. The default is false.
Use this property when you need to map fields without sensitivity to the precise order in which differently named nodes appear in the XML. This is probably a more useful option than setting the generateSiblingOrderSuffix property for most users of the XML codec.
generateSiblingOrderSuffix — If true, all field names for text, CDATA and element nodes (except the root element) are appended with "#1", "#2", and so on. The number specifies the position of this node relative to all its siblings (of any type, such as element or CDATA.). These order suffixes provide a total order for the XML nodes. The default is true.
Use this property when you need to map fields using the precise order in which differently named nodes appear in the XML, or for total control over node ordering when generating XML upstream.
Examples of both suffixes are in Description of event fields that represent normalized XML and Examples of conversions.
You can set both node order properties to true. For sample output when both are set to true, see Examples of conversions. The default values of these two properties may change in a future release, so the recommendation is to explicitly specify both properties according to the behavior required.