StringArray.SplitSort(String, String, Array) Method

 Top 

Description

Splits each element of StringArray into columns based on the delimiter specified by stringArgument1, then sorts the columns based on the precedence specified by arrayArgument. Then reforms each row, using stringArgument2 to merge the columns.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

StringArray.SplitSort(

String stringArgument1,

String stringArgument2,

Array arrayArgument)

 

 

Arguments

stringArgument1

Description:

Delimiter to use when splitting the StringArray.

 

 

stringArgument2

Description:

Delimiter to use when re-merging the StringArray.

 

 

arrayArgument

Description:

Array used to specified the precedence of the columns to be sorted.

 

 

 

Return Value

Type:

number

 

 

Returns the number of rows in the calling StringArray.

 

Syntax

myVariable1 = myStringArray1.SplitSort(myString1, myString2, myArray1);

 

 

Example 1

This example demonstrates how to use the StringArray.SplitSort method to split a StringArray into columns, sort the columns based on the precedence specified by an input Array, and then reform the rows using a space as the new delimiter.

 

// Create Objects

StringArray StringArraytoSplitSort;

String delim1;

String delim2;

Array PrecedenceArray;

 

// Set delimiters

delim1 = ", ";

delim2 = " ";

 

// The argument Arrays will be sorted according to the order specified in PrecedenceArray (3, 2, 1)

PrecedenceArray = {3,2,1};

 

StringArraytoSplitSort = {"Mary, Thomas, F",

                                 "James, Thomas, M",

                                 "Thomas, Smith, M",

                                 "James, Smith, M",

                                 "Daniel, Jones, M",

                                 "Susan, Smith, F",

                                 "David, Adams, M",

                                 "Anna, Johnson, F",

                                 "John, Brown, M",

                                 "Robert, Williams, M"};

 

// Pass inputs to SplitSort - each element of the calling StringArray will be split into columns

// based on the delimiter specified by delim1 (a comma), then the columns will be sorted based

// on the precedence specified by PrecedenceArray (3, 2, 1). Then, the rows are reformed, using

// delim2 (a space) to merge the columns.

 

StringArraytoSplitSort.SplitSort(delim1, delim2, PrecedenceArray);

 

// Report out the sorted StringArray

For i = 0 to StringArraytoSplitSort.Dimension-1 step 1;

 Report StringArraytoSplitSort[i];

End;

 

 

Output Report:

 

StringArrayToSplitSort

Anna Johnson F

Susan Smith F

Mary Thomas F

David Adams M

John Brown M

Daniel Jones M

James Smith M

Thomas Smith M

James Thomas M

Robert Williams M

 

 

 

 

 

See also

StringArray Object

StringArray.SplitSort

Parsing Arbitrary String Data