Page History

#foreach ($rel in $sorter.sort($package, "name"))
$rel.name
#end

$sorter.sort(

collection)

This is the sort function for report templates. The context name of this class is "sorter". Use $sorter to access public functions of this class through the templates.

For example:

#foreach ($rel in $sorter.sort($package))
$rel.name
#end

• $package is a collection to be sorted.

$sorter.sort(collection, fieldNameCollection, direction)

This sort function allows specifying more than one field name to be sorted. The priority of fields is ranked by the sequence in the fieldNameCollection parameter.

For example:

#foreach ($p in $sorter.sort($Package, ["version", "name"], "desc"))
$p.name
#end

• $package is a collection to be sorted.

$sorter.sort(collection,

fieldName, direction, isCaseInsensitive)

This sort function allows specifying more than one field name to be sorted. The priority of fields is ranked by the sequence in the fieldNameCollection parameter.parameter. This function allows case-sensitive sorting.

For example:

$sorter.sortByFirstNumber(collection, fieldName)

The sortByFirstNumber function is for report templates. The context name of this class is "sorter". Use $sorter to access public functions of this class through templates.

For example:

#foreach ($rel in $sorter.sortByFirstNumber($package, "name:desc"))
$rel.name
#end

• $package is a collection to be sorted by FirstNumber.
• "name:desc" is separated by ":" in two parts:
  • The first part is to identify fieldName to be sorted.
  • The second part is the option to identify the sorting direction. Sometimes, the direction is not identified. It is ascending by default.

$sorter.sortByFirstNumber(collection)

The sortByFirstNumber function for report templates. The context name of this class is "sorter". Use $sorter to access public functions of this class through templates.

For example:

#foreach ($rel in $sorter.sortByFirstNumber($package)) 
$rel.name
#end

• $package is a collection to be sorted by FirstNumber.

$sorter.sortByLocale(collection, String)

This is a function to sort for report templates. The context name of this class is "sorter". Use $sorter to access public functions of this class through templates. To sort a given collection by a particular language, identify the country code to specify the language.

For example:

#foreach ($p in $sorter.sortByLocale($package, "DE"))
$p.name
#end

• $package is a collection to be sorted by country code.
• "DE" is the country code for GERMANY (ISO country code).
  
  

$sorter.sortByLocale(collection, String, String)

This is a function to sort for report templates. The context name of this class is "sorter". Use $sorter to access public functions of this class through templates. To sort a given collection by a particular language, specify the language by identifying the country code and field name.

For example:

#foreach ($p in $sorter.sortByLocale($package, "name", "DE"))
$p.name
#end

• $package is the collection to be sorted.
• “name” is the field name to be sorted.
• "DE" is the country code for GERMANY (ISO country code).

$sorter.humanSort(collection, fieldName)

This is a special function to sort text in a human-like order. It splits text into numeric and non-numeric chunks and sorts them in numerical order. For example, "foo10" is ordered after "foo2".

For example:

#foreach ($rel in $sorter.humanSort($package, "name:desc"))
$rel.name
#end

•  $package is the collection to be sorted.
• "name:desc" is separated by ":" in two parts:
  • The first part is to identify fieldName to be sorted.
  • The second part is the option to identify the sorting scheme. Sometimes, the order is not identified. It is ascending by default.

$sorter.humanSort(collection)

This is a special function to sort text in a human-like order. It splits text into numeric and non-numeric chunks and sorts them in numerical order. For example, "foo10" is ordered after "foo2".

For example:

#foreach ($rel in $sorter.humanSort($package))
$rel.name
#end

• $package is the collection to be sorted.

$sorter.humanSort(collection, fieldNameCollection, direction)

This humanSort function allows specifying more than one field name to be sorted. The priority of fields is ranked by the sequence in the fieldNameCollection parameter.

For example:

#foreach ($p in $sorter.humanSort($Package, ["version", "name"], "desc"))
$p.name
#end

$sorter.containmentTreeSort(collection)

This function is for sorting elements that match the Containment tree order.

$sorter.tagSort(collection, stereotypeName, tagName)

This function is for sorting a collection item by specifying an applied stereotype name and tag name.

For example:

#foreach($p in $sorter.tagSort($Package, "MyStereotype", "tagA:desc"))
$report.getStereotypePropertyString($p, "Mystereotype", "tagA") :: $p.name
#end

• $package is the collection to be sorted.
• "name:desc" is separated by ":" in two parts:
  • The first part is to identify tagName to be sorted.
  • The second part is the option to identify the sorting scheme. Sometimes, the order is not identified. It is ascending by default.

$sorter.tagSort($collection, $stereotypeName, $tagName, $forceNumber)

This function is for sorting a collection item by specifying an applied stereotype name and tag name and forcing a tag value to convert to a numeric before sorting.

For example:

#foreach($p in $sorter.tagSort($Package, "MyStereotype", "tagA:desc", true))
$report.getStereotypePropertyString($p, "Mystereotype", "tagA") :: $p.name
#end

• $package is the collection to be sorted.
• "name:desc" is separated by ":" in two parts:
  • The first part is to identify tagName to be sorted.
  • The second part is the option to identify the sorting scheme. Sometimes, the order is not identified. It is ascending by default.
• If this parameter is not defined in the function, the forceNumber default value of false will be applied.

$sorter.tagSort($collection, $stereotype, $tagName)

This function is for sorting a collection item by specifying an applied stereotype object and tag name.

For example:

#foreach($p in $sorter.tagSort($Package, $stereotype, "tagA:desc"))
$report.getStereotypePropertyString($p, "Mystereotype", "tagA") :: $p.name
#end

• $package is the collection to be sorted.
• "name:desc" is separated by ":" in two parts:
  • The first part is to identify tagName to be sorted.
  • The second part is the option to identify the sorting scheme. Sometimes, the order is not identified. It is ascending by default.

sorter.tagSort($collection, $stereotype, $tagName, $forceNumber)

This function is for sorting a collection item by specifying an applied stereotype object and tag name and forcing a tag value to convert to a numeric before sorting.

For example:

#foreach($p in $sorter.tagSort($Package, $stereotype, "tagA:desc", true))
$report.getStereotypePropertyString($p, "Mystereotype", "tagA") :: $p.name
#end

• $package is the collection to be sorted.
• "name:desc" is separated by ":" in two parts:
  • The first part is to identify tagName to be sorted.
  • The second part is the option to identify the sorting scheme. Sometimes, the order is not identified. It is ascending by default.
• If this parameter is not defined in the function, the forceNumber default value of false will be applied.