Sort builder inputs - Portlet Factory v6.1.2

Portlet Factory, Version 6.1.2

Sort builder inputs

This topic describes the inputs for the Sort builder.

Table 1. Sort builder inputs
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Page Location Use the Page Location input to specify the page or pages on which this builder call will act.
Use the Tag input to specify the tag name for the column on which you want to enable sorting. If you are using the Column Sort builder with a Data Page builder, choose the appropriate column_nameHeader tag.
Data to Sort Specify an indirect reference to the XML node that contains the data you want to sort.
For example: ${Variables/data_variable/employeeList/employees}
Element Name Enter the name of the XML node on which the sort will be based.
For example: empname
Note: Use an indirect reference for the element name only when the name of the XML node will be located at that reference at runtime. This might be the case when a variable is used to store a node name at runtime.
For example: ${Variables/column_to_sort}
Column Link Text Use the reference chooser or enter the text directly for the link's displayed text. This text replaces any column header text specified in the HTML or another builder call.
Sort Type Specify the type of sort you want to perform and on the type of data to be sorted.

Case Insensitive String

Sorts column data as strings, ignoring the case (A or a) of any character.

Case Sensitive String

Sorts column data as strings, taking into account the case of each character. Lower-case letters are "greater than" upper-case letters; the ASCII values for each character in the string are used in the comparison.

Date

Sorts column data as Date values. All possible Date formats may be used.

Numbers

Sorts the column data based on the numerical value of each item.

Date Format This input is available when the Date Sort Type is selected above. Specify a date format on which to base this sort.
If you select a specific format, the builder call editor displays a sample Date value in that format. You can also enter a date format manually.
All patterns supported by the SimpleDateFormat Java class are supported.
You can choose the following formats:

Server's Default

Prompts the Sort builder to use the default Date format as defined on the machine on which the application server runs.

MM/dd/yy

For example: 11/23/03

MM/dd/yyyy

For example: 11/23/2004

MMM dd, yyyy

For example: Nov 23, 2003

MMMM dd, yyyy

For example: November 23, 2003

Parent topic: Sort builder

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Page Location	Use the Page Location input to specify the page or pages on which this builder call will act. Use the Tag input to specify the tag name for the column on which you want to enable sorting. If you are using the Column Sort builder with a Data Page builder, choose the appropriate column_nameHeader tag.
Data to Sort	Specify an indirect reference to the XML node that contains the data you want to sort. For example: ${Variables/data_variable/employeeList/employees}
Element Name	Enter the name of the XML node on which the sort will be based. For example: empname Note: Use an indirect reference for the element name only when the name of the XML node will be located at that reference at runtime. This might be the case when a variable is used to store a node name at runtime. For example: ${Variables/column_to_sort}
Column Link Text	Use the reference chooser or enter the text directly for the link's displayed text. This text replaces any column header text specified in the HTML or another builder call.
Sort Type	Specify the type of sort you want to perform and on the type of data to be sorted. Case Insensitive String Sorts column data as strings, ignoring the case (A or a) of any character. Case Sensitive String Sorts column data as strings, taking into account the case of each character. Lower-case letters are "greater than" upper-case letters; the ASCII values for each character in the string are used in the comparison. Date Sorts column data as Date values. All possible Date formats may be used. Numbers Sorts the column data based on the numerical value of each item.
Date Format	This input is available when the Date Sort Type is selected above. Specify a date format on which to base this sort. If you select a specific format, the builder call editor displays a sample Date value in that format. You can also enter a date format manually. All patterns supported by the SimpleDateFormat Java class are supported. You can choose the following formats: Server's Default Prompts the Sort builder to use the default Date format as defined on the machine on which the application server runs. MM/dd/yy For example: 11/23/03 MM/dd/yyyy For example: 11/23/2004 MMM dd, yyyy For example: Nov 23, 2003 MMMM dd, yyyy For example: November 23, 2003