Message Library Properties (Sun HL7 Message Library User's Guide)

Sun HL7 Message Library User's Guide

Message Library Properties

The Object Type Definition pane of the Message Library Editor displays the nodes, elements, and fields of the Message Library. When any of these are selected, the item’s properties are displayed in the Properties pane.

The following topics list and describe each property:

Node Properties

When an HL7 Message Library is opened in the Message Library Editor, the properties of the root node are displayed in the Properties pane. The configurable node properties are shown in the following figure and described in the table below.

Property	Description
name	The node display name. This can be any string.
javaName	The property accessor basename. This is normally derived from the display name, modified to suit the restrictions on Java identifiers, and supplied automatically by the Sun Enterprise Service Bus. Do not modify this property.
javaType	The Java type. This is automatically assigned, and not is editable.
comment	Free-form text (no runtime effect).
delim	The specified delimiter. See Specifying Delimiters.
nodeType	Governs the marshal/unmarshal format. See Specifying the Node Type.
antecoding	The input data coding. See Changing HL7 Standard Encoding Characters. If this property is not specified, the value specified for the `decoding` property will be used for the input data. This property is displayed only when the top property is set to `true`.
decoding	The unmarshal coding. See Changing HL7 Standard Encoding Characters. It is recommended to use UTF-8 for DBCS data, since the hex value of some ASCII delimiter may coincide with a hex value contained within a double-byte character. This property is displayed only when the `top` property is set to `true`.
encoding	The marshal coding. This property is displayed only when the `top` property is set to `true`.
order	Specifies the ordering of the root node’s children: seq: Specifies that the child nodes must appear in sequence. any: Specifies that the child nodes can appear in any order. mix:
postcoding	Specifies the output data coding (see Specifying Data Encoding on page 219). If this property is not specified, the value specified for the encoding property will be used for the output data. This property is displayed only when the `top` property is set to `true`.
public	Reserved for future development
rootClassName	The Java class name corresponding to the root node.
top	An indicator of whether the root node supports marshal/unmarshal (T/F).

Element Properties

The set of properties associated with the element level is shown in the following figure and is described in the table below.

Figure 1 Message Library Editor - Message Library Element Properties

Property	Descriptions
name	The element display name.
javaName	Property accessor basename. Do not modify this property; it is assigned by the Sun Enterprise Service Bus.
javaType	The Java type. This is automatically assigned, and is not editable.
comment	Free-form text (no runtime effect).
access	The access specification.
optional	An indicator of whether the element is required or optional. Specify `true` if the element is optional; otherwise specify `false`. This is not applicable to the root or to a child of a choice node.
repeat	An indicator of whether the element can have multiple instances. Specify `true` if the element can appear multiple times; otherwise specify `false`. This is not applicable to the root or to a child of a choice node.
maxOccurs	The maximum number of occurrences of the node if the node is repeating. This property has no effect if node is non-repeating, but might show an error during validation if set to a value greater than 1.
delim	The delimiter specification (see Specifying Delimiters).
nodeType	Governs the marshal/unmarshal format. See Specifying the Node Type.
showDelim	If the `nodeType` property is delimited, the delimiter appears here. This field is not editable.
public	For future use, not currently active.
top	An indicator or whether marshal/unmarshal is supported. Specify `true` if it is supported; otherwise specify `false`.

Field Properties

The set of properties associated with the field level is shown in the following figure and is described in the table below.

Figure 2 Message Library Editor - Message Library Field Properties

Property	Descriptions
name	The field display name.
javaName	The property accessor basename. Do not modify this property; it is assigned by the Sun Enterprise Service Bus.
javaType	The Java type. This can be either java.lang.String or byte array (byte[]).
comment	Free-form text (no runtime effect).
access	The access specification.
optional	An indicator of whether the field can be absent from an instance. Clicking the Value field toggles between true and false. Not applicable if the field is the child of a choice element node.
repeat	Specifies whether or not the node can appear multiple times. Specify `true` is the node is options; specify `false` if it is required. Click in the field to toggle between true and false. This is not applicable if the field is the child of a choice element node.
maxOccurs	The maximum number of occurrences of the node if the node is repeating. This property has no effect if the node is non-repeating, but it might show an error during validation if set to a value greater than 1.
delim	The delimiter specification (see Specifying Delimiters).
initial	The initial field value, which is set when the parent node is created or reset. When provided, it is assigned to the node before the node is populated with any data.
match	If `nodeType` is delimited, performs an exact match to the data.
nodeType	Governs the marshal/unmarshal format. See Specifying the Node Type.
align	Specifies the byte alignment criteria for the match property.
decoding	The unmarshal coding. This is displayed only if the `nodeType` property is set to fixed. It is recommended to use UTF-8 for DBCS data, since the hex value of some ASCII delimiter may coincide with a hex value contained within a doublebyte character.
encoding	The marshal coding. This property is displayed only if the `nodeType` property is set to fixed.
length	The length of the field. This property is displayed only if the `nodeType` property is set to fixed.