Skip to content

Source Object

The source object is a read-only copy of the message as it was received by the channel. The available source object functions are listed below, along with the message models on which each function is supported.

Function Description Applies To
Check Node Exists Check for the existence of 1 or more nodes that match the nodePath. All message models except Binary
Check Node is Blank Checks if a node that matches the nodePath exists and is whitespace, empty ('') or null. All message models except Binary
Check Node is Not Blank Checks if a node that matches the nodePath exists, is not whitespace, is not empty (''), and is not null. All message models except Binary
Get All Nodes Get the result for all nodes that match the nodePath. All message models except Binary
Get Bytes Get the byte array associated with the current message. All message models
Get Count Get the result of nodes that match the nodePath. All message models except Binary
Get Last Node Get the result of the last node that matches the nodePath. All message models except Binary
Get Node Get the result of the first node that matches the nodePath. On Binary, / is the only valid node path and it returns the whole payload as a string. All message models
Get Row Count Get the number of rows in a message. HL7, ASTM, CSV, DICOM
Length Get the number of bytes in the message. Binary
To String Get the message value as a string. All message models

A Binary message has no node structure, so the node tests do not apply to it. Use Length to check whether a Binary message has a payload; to check for a payload that is only whitespace, pass To String to StringUtils.isBlank.