Compare (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Syntax terms) |
||
| (17 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Compare subtitle}} | {{Template:Stringlist:Compare subtitle}} | ||
This method compares two | This method compares two <var>Stringlist</var>s and produces a <var>Stringlist</var> describing the differences between the two. | ||
The Compare method object, that is, the Stringlist against which Compare is being run, must have 8-byte long sequence numbers at the start of each item. As the term "sequence numbers" suggests, these numbers must consist exclusively of numeric characters with no leading blanks, and the numbers must be in sequential order. That is, the sequence number in each Stringlist item must be greater than the sequence number in the preceding item. | The <var>Compare</var> method object, that is, the <var>Stringlist</var> against which <var>Compare</var> is being run, must have 8-byte long sequence numbers at the start of each item. As the term "sequence numbers" suggests, these numbers must consist exclusively of numeric characters with no leading blanks, and the numbers must be in ascending, sequential order. That is, the sequence number in each <var>Stringlist</var> item must be greater than the sequence number in the preceding item. | ||
==Syntax== | ==Syntax== | ||
| Line 9: | Line 9: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%outList</th> | ||
<td>A Stringlist to contain the result of the comparison of the method and | <td>A <var>Stringlist</var> to contain the result of the comparison of the method input (<var class="term">sl</var>) and <var class="term">inList</var> <var>Stringlist</var>s.</td></tr> | ||
<tr><th>sl</th> | <tr><th>sl</th> | ||
<td>A Stringlist object.</td></tr> | <td>A <var>Stringlist</var> object. The first 8 characters of each item must be an 8-digit increasing integer; these are used as sequence numbers for the <var class="term">%outList</var> items. The comparison is made using the <var class="term">sl</var> items following the sequence numbers.</td></tr> | ||
<tr><th> | <tr><th>inList</th> | ||
<td>The input Stringlist, which contains data that does not include 8-byte sequence numbers. This is a required argument.</td></tr> | <td>The input <var>Stringlist</var>, which contains data that does not include 8-byte sequence numbers. This is a required argument.</td></tr> | ||
<tr><th> | <tr><th>syncCount</th> | ||
<td>A number indicating a synchronization count. When | <td>A number indicating a synchronization count. When <var class="term">sl</var>, the method <var>Stringlist</var>, and the <var class="term">inList</var> <var>Stringlist</var> are being compared and a difference is found, <var class="term">syncCount</var> indicates the number of lines that must match before they are treated as a true match. This is an optional argument, and it defaults to 1.</td></tr> | ||
<tr><th>pad</th> | <tr><th>pad</th> | ||
<td>The pad character to be used to pad any input | <td>The pad character to be used to pad any input item during the comparison to items in the other input <var>Stringlist</var>. This is an optional argument, and it defaults to blank.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>All errors in Compare result in request cancellation.</ul> | <ul><li>All errors in <var>Compare</var> result in request cancellation.<li>The output <var>Stringlist</var> produced by <var>Compare</var> is in a format that is suitable as input to <var>[[Update (Stringlist function)|Update]]</var>.</ul> | ||
==Examples== | ==Examples== | ||
For example, assume the <var>Stringlist</var> object, identified by <code>%objList</code>, contains these items: | |||
<p class="code">00010000b | |||
< | |||
00010000b | |||
00020000 | 00020000 | ||
00030000print 'Quentin Compson' | 00030000print 'Quentin Compson' | ||
00040000 | 00040000 | ||
00050000end | 00050000end | ||
</ | </p> | ||
And the input argument <var>Stringlist</var>, identified by <code>%argList</code>, contains these items: | |||
And the input argument Stringlist contains these items: | <p class="code">b | ||
< | |||
b | |||
print 'Quentin Compson' | print 'Quentin Compson' | ||
| Line 44: | Line 39: | ||
end | end | ||
</ | </p> | ||
This statement compares the Stringlists: | This statement compares the two <var>Stringlists</var>: | ||
< | <p class="code">%outList = %objList:compare(%argList) | ||
%outList = %objList:compare(%argList) | </p> | ||
</ | |||
The result is the Stringlist identified by %outList, which contains: | The result is the <var>Stringlist</var>, identified by <code>%outList</code>, which contains: | ||
< | <p class="code">.li;./ I 00030000 $ 00030001 00010000 | ||
.li;./ I 00030000 $ 00030001 00010000 | |||
print 'Harvard Diving Team, 1908' | print 'Harvard Diving Team, 1908' | ||
</ | </p> | ||
The method <var>Stringlist</var> for <var>Compare</var> (<code>%objlist</code>, above) can be most easily created with <var>[[AppendOpenProcedure (Stringlist function)|AppendOpenProcedure]]</var>, using the third parameter, <var class="term">seqIncrement</var>, to indicate a sequence number. | |||
The method Stringlist for Compare (< | |||
==See also== | |||
{{Template:Stringlist:Compare footer}} | |||
Latest revision as of 11:28, 9 November 2012
Compare two Stringlists and produce Stringlist describing differences (Stringlist class)
This method compares two Stringlists and produces a Stringlist describing the differences between the two.
The Compare method object, that is, the Stringlist against which Compare is being run, must have 8-byte long sequence numbers at the start of each item. As the term "sequence numbers" suggests, these numbers must consist exclusively of numeric characters with no leading blanks, and the numbers must be in ascending, sequential order. That is, the sequence number in each Stringlist item must be greater than the sequence number in the preceding item.
Syntax
[%outList =] sl:Compare( inList, [syncCount], [pad])
Syntax terms
| %outList | A Stringlist to contain the result of the comparison of the method input (sl) and inList Stringlists. |
|---|---|
| sl | A Stringlist object. The first 8 characters of each item must be an 8-digit increasing integer; these are used as sequence numbers for the %outList items. The comparison is made using the sl items following the sequence numbers. |
| inList | The input Stringlist, which contains data that does not include 8-byte sequence numbers. This is a required argument. |
| syncCount | A number indicating a synchronization count. When sl, the method Stringlist, and the inList Stringlist are being compared and a difference is found, syncCount indicates the number of lines that must match before they are treated as a true match. This is an optional argument, and it defaults to 1. |
| pad | The pad character to be used to pad any input item during the comparison to items in the other input Stringlist. This is an optional argument, and it defaults to blank. |
Usage notes
- All errors in Compare result in request cancellation.
- The output Stringlist produced by Compare is in a format that is suitable as input to Update.
Examples
For example, assume the Stringlist object, identified by %objList, contains these items:
00010000b 00020000 00030000print 'Quentin Compson' 00040000 00050000end
And the input argument Stringlist, identified by %argList, contains these items:
b print 'Quentin Compson' print 'Harvard Diving Team, 1908' end
This statement compares the two Stringlists:
%outList = %objList:compare(%argList)
The result is the Stringlist, identified by %outList, which contains:
.li;./ I 00030000 $ 00030001 00010000 print 'Harvard Diving Team, 1908'
The method Stringlist for Compare (%objlist, above) can be most easily created with AppendOpenProcedure, using the third parameter, seqIncrement, to indicate a sequence number.