[DERBY-5885] The order of argument names in messages.xml is sometimes wrong when the arguments occur in the message out of sequence.

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 10.10.1.1
• Fix Version/s: 10.10.1.1
• Component/s: Documentation, Localization
• Assignee: Richard N. Hillegas
• Reporter: Richard N. Hillegas
• Created: 26/Jul/12 19:25
• Updated: 14/Jun/13 17:12
• Resolved: 24/Jan/13 16:39

Description

In most Derby messages, arguments appear in ascending order. That is,

{0} occurs in the message first, then {1}, then {2}, and so on. Sometimes, however, arguments occur out of sequence. When this happens, the names in the <arg> sub-elements may not agree with the order that the arguments actually occur in the message. This causes MessageBuilder to garble the dita source for the Reference Guide page titled "SQL error messages and exceptions".

For instance, here is the messages.xml element for SQLState 22014:

<msg>
<name>22014</name>
<text>The start position for LOCATE is invalid; it must be a positive integer. The index to start the search from is '{2}'. The string to search for is '{0}

'. The string to search from is '

{1}'. </text>
<arg>startIndex</arg>
<arg>searchString</arg>
<arg>fromString</arg>
</msg>

This gives rise to the following garbled text in the generated reference guide page:

"The start position for LOCATE is invalid; it must be a positive integer. The index to start the search from is '<fromString>'. The string to search for is '<startIndex>'. The string to search from is '<searchString>'. "

We should re-order the <arg> sub-elements so that the first <arg> sub-lement corresponds to {0}, the second <arg> sub-element corresponds to {1}

, and so on.

Issue Links

• is related to: DERBY-2774 Desciption of variable part in error message of XSLAM was not exists in Derby reference manual.
• relates to: DERBY-2705 Description of error message for X0X61/X0Y59/X0Y69/X0Y70 in SQL error messages and exceptions of Reference manual is not appropriate.
• relates to: DERBY-5879 Fix problems in English messages disclosed by a localization audit.