Name |
Description |
---|---|
Encoding Style |
Specifies the encoding style, for example: customencoder-[version]. |
Node Type |
Specifies the format for parsing and serialization. The options are:
The default value is delimited. See also Node Type Default Values (following this table) for more information. |
Delimiter List |
Opens the Delimiter List Editor. See Specifying Delimiters for information. |
Order |
Specifies the ordering of the selected group node or complex type element node’s children during the parsing process.
Does not apply to choice element nodes. See Order Property for additional information. |
Table 2 Root Node Properties
Name |
Description |
---|---|
Top |
Specifies whether or not parsing/serializing encoding is supported for descendant nodes. The default value is true (checked box). |
Input Charset |
Specifies the character set of the input data. This is only needed if the parsing is done upon byte array data and the character set that the byte array data is encoded against is not safe for delimiter scanning. If this property is not specified, the value specified for the Parsing Charset property will be used. This property is displayed only when the Top property is set to true (checked box). Applies to root node only. See Data Encoding for additional information. |
Output Charset |
Specifies the character set of the output data if it needs to be different from the serializing character set. If this property is not specified, the value specified for the Serializing Charset property will be used. This property is displayed only when the Top property is set to true (checked box). SeeData Encoding for additional information. Note – This character set may be unsafe for delimiter scanning. |
Parsing Charset |
Specifies the character set used to decode byte array data into string during parsing. 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 (checked box). SeeData Encoding for additional information. |
Serializing Charset |
Specifies the character set used to encode string data into byte array data during serialization of the data. This property is displayed only when the Top property is set to true (checked box). SeeData Encoding for additional information. |
Escape Sequence |
Global-level escape sequence, which should be set only at the root level. This property is displayed only when the top property is set to true (checked box).. |
Fine Inherit |
When set to true (checked box), enables the following delimiters to be inherited individually from the parent nodes:
Otherwise, once a delimiter level is specified for a child node, it overrides the relevant delimiter level as a whole on parent nodes. This setting is global, so the flag only needs to be set on a root element. The default value is false (unchecked box). Displayed only when the top property is set to true (checked box). |
Undefined Data Policy |
Specifies whether or not undefined (trailing) data is allowed and/or will be mapped. This property is displayed only when the top property is set to true (checked box). The options are as follows:
This setting is global, so the flag only needs to be set on a root element. |
Table 3 Leaf Node Properties
Name |
Description |
---|---|
Match |
Defines match pattern. If alignment is regex, then this field holds the regex match pattern. See Matching Data Patterns for more information. |
No Match |
Flag indicating if the match condition should be reverted. The flag acts as a logical NOT against the match condition. See Matching Data Patterns for more information. |
Alignment |
Defines the alignment mode for a match pattern. See Matching Data Patterns for more information. |
NofN minN |
Specifies the minimum number of child nodes that must contain data. If absent, then so such constraint exists. |
NofN maxN |
Specifies the maximum number of child nodes that must contain data. If absent, then so such constraint exists. |
MinOcc |
Specifies the minimum number of occurrences of a repeating node. The value specified here overrides the minOccurs value in XSD's element declaration. This property is needed only when the order is mixed; so in the XSD, repeating choice group must be used, and the minOccurs specified in the XSD does not actually represent the minimum occurrence. |
MaxOcc |
Specifies the maximum number of occurrences of a repeating node. The value specified here overrides the maxOccurs value in XSD's element declaration. This property is needed only when the order is mixed; so in the XSD, repeating choice group must be used, and the maxOccurs specified in the XSD does not actually represent the maximum occurrence. |
Scavenger Chars |
Specifies the characters to be stripped out when parsing the data, if they appear at the start of the byte stream for this element. |
Output Scavenger 1st Char |
Specifies the character to be stripped out when serializing the data, if it appears as the first character of the output byte stream from this element (even occurring before the begin delimiter, if any). |
Delimiter |
Displayed for delim Node Type only. Once delimiters are specified, the value field displays the delimiter characters (read only). |
Begin Delimiter |
Once begin delimiters are specified, the value field displays the delimiter characters (read only). |
Begin Delimiter Detached |
Specifies whether the begin delimiter is anchored or detached. The default value is false (unchecked box), indicating an anchored delimiter. |
Array Delimiter |
Displayed for array Node Type only. Once delimiters are specified, the value field displays the delimiter characters (read only). |
Fixed Length |
Displayed for fixedLength Node Type only. The options are:
|
Length |
Displayed only for fixedLength Node Type with the regular option. Specifies the length of the field in terms of bytes (as a positive integer). The default value is 0. |
Offset |
Displayed only for fixedLength Node Type with the regular option. Specifies the offset of the field in terms of bytes (as a positive long integer) from the zero position where the first sibling starts. The default value is 0. |
Encoded Field Length |
Displayed only for fixedLength Node Type with the encoded option, and specification is required. Specifies the length of the encoded field in terms of bytes (as a positive integer). The default value is 0. |
Encoded Field Offset |
Displayed only for fixedLength Node Type with the encoded option, and specification is optional. Specifies the offset in terms of bytes (as a positive long integer) from the position where the first sibling starts. |
Encoded Field Position |
Displayed only for fixedLength Node Type with the encoded option, and specification is required. Specifies the offset in terms of bytes (as a positive long integer) between the current parsing position and the position from which the Encoded Field Length is defined. |
Length From End |
Displayed only for fixedLength Node Type with the deducted from end option. |
The basic default value for the nodeType property is delimited. If, however, the node is the child of a parent node whose Node Type is fixedLength or transient, then the child takes on the same Node Type as the parent. See the following table for additional information.
This rule does not apply to Choice Element nodes.
Parent |
Child |
---|---|
array |
delimited |
delimited |
delimited |
fixed |
fixed |
group |
delimited |
transient |
transient |
To illustrate how the order property works, consider the simple tree structure shown in the following diagram, where a is an element node, b is a non-repeating field node, and c is a repeating field node. The value set for the order property allows the field nodes to appear as shown in following table.
Value |
Allowed Node Order |
---|---|
sequence |
b, c1, c2 |
any |
b, c1, c2, or c1, c2, b |
mixed |
b, c1, c2, or c1, c2, b, or c1, b, c2 |