A search result table control that uses the My webMethods Server search result table look-and-feel.

The Async Search Result Table control pages and sorts records (rows) using asynchronous requests. You can use the bufferChunk, bufferMin, bufferMax, clientSideCache, flashOnChange, progressDelay, progressMsg, and suppressInputs attributes to customize the table's asynchronous behavior.

For more information on the com.webmethods.caf.faces.table.AsyncTable, see the Async Table control.

If you generate a SearchResult portlet in Composite Application Framework, the portlet preferences are generated by the application. For more information, see information about setting preferences for the Search Results portlet in the portlet preferences description in the webMethods CAF Development Help.

To provide custom content for the export, such as to get a set of columns with more machine-friendly formatted data, you can bind the Async Search Result Table control's exportProvider property value to a separate com.webmethods.caf.faces.data.ITableContentProvider instance. A convenient ITableContentProvider implementation designed for CSV export is the com.webmethods.caf.faces.data.export.CSVExportProvider class. It maps the content of an existing ITableContentProvider (usually the provider that provides the raw data for the table) to a custom set of columns, with each column's content specified by a binding expression.

The following example demonstrates creating a CSVExportProvider in a custom page bean method. (You would bind the property for which this method is a getter, "myExportProvider", to the Async Search Result Table control's exportProvider property value.) It assumes that there is already an existing table content provider for the raw table data, accessible via the getMyExistingTableContentProvider() method. It creates four columns: "ID", "Title", "Priority", and "Priority Name". Additionally, it specifies the content of these columns with binding expressions: #{row.projectId}_#{row.id}, #{row.title}, #{row.priorityValue}, and #{row.priorityName}. The name of the row variable, in this case "row", must be specified as the third argument to the CSVExportProvider constructor.) For each row, the content of the "ID" column in the exported table will be generated from the value of the existing table row's "projectId" and "id" properties; the content of the "Title" column will be generated from the value of the existing table row's "title" property; and so on.

public ITableContentProvider getMyExportProvider() {
   ITableContentProvider existingProvider = getMyExistingTableContentProvider();
   Map keys = new LinkedHashMap();
   keys.put("ID", createValueBinding("#{row.projectId}_#{row.id}"));
   keys.put("Title", createValueBinding("#{row.title}"));
   keys.put("Priority", createValueBinding("#{row.priorityValue}"));
   keys.put("Priority Name", createValueBinding("#{row.priorityName}"));
   return new CSVExportProvider(existingProvider, keys, "row");
}


Note that because the exported table's column labels are simply the column keys ("ID", "Title", "Priority", and "Priority Name"), it is a good practice to use string resources from a resource bundle instead of hardcoding the labels. The labels are hardcoded in this example for simplicity. Note also, that the example uses a LinkedHashMap, which ensures that the columns will be exported in the order they were added to the keys map. The exported CSV might look like the following:

ID, Title, Priority, Priority Name
higgins_123, Nothing Works, 1, Critical
higgins_ABC, "Name should be ""MWS""", 3, Medium


The export processing handles the escaping of column values (in the example output above, the Name should be "MWS" value is escaped as "Name should be ""MWS""").

Children

javax.faces.Column, Basic Column control