Introduction
Description
AddRecordData Default Formatting Class
Introduction
In
this topic, the default formatting class, AddRecordData is featured to
illustrate how formatting classes are used to format data in the WebZ
Interface.
When executed, a formatting class is responsible for creating an element in the display. As in the following example, this can be demonstrated in the WebZ Out-of-the-Box Interface, version 1 with the Language field for a fully displayed record from the ABI/Inform (ABII) database.
Example Formatting Class in a Rule Specification
| Notes: |
A set of predefined
formatting classes
is located in the directory, <WebZ_root>classes/ORG/oclc/fmts/rules.
They are designed to eliminate your need for programming or understanding
Java code when you are defining
or modifying a format. |
AddRecordData Default Formatting Class
AddRecordData is the default record formatting class (rule) that creates a formatted string from the fields defined in a rule specification. As with many other formatting classes (or rules), AddRecordData recognizes additional parameters that more specifically tailor its functionality to a particular element in a display.
Parameters
The default formatting
class, AddRecordData recognizes the following parameters when they are
used in a rule specification:
|
Parameter |
Description |
|
command |
This is the QUERY command to use when there is an index specified in the description to create a query. |
| cleanUpQuery | A true or false value indicates whether or not any filtering is to be done by the formatting class on the data going into the query anchor. The default is true. |
| nextPage | This is the next=page value in the anchor. The default, if not specified, is &StyleTable.pages.searchResults. |
| badPage | This is the bad=page value in the anchor. The default, if not specified, is &StyleTable.pages.badquery. |
| queryWidgets | These are widgets to add to the query. If not specified, the default is entityoprecno=1$entitycurrecno=1&numrecs=&srchnumrecs. |
| target | This is the target value for the anchor. The default, if not specified, is &StyleTable.targets.searchResults. |
| saveInEntityName | This is the user state entity name that stores the formatted string created by rule. If not specified, the data is appended to the formatting buffer. |
| dupEntityName | This is the entity name containing the formatted duplicate data field. If this parameter is used, any data held in the input entity name is appended to the formatting buffer and is removed from the user state. |
| beforeLabelWrapperName | This is the name of the data wrapper for the string that is appended before the field display label. If not specified, the default is beforeFieldLabel. |
| afterLabelWrapperName | This is the name of the data wrapper for the string that is appended after the field display label. If not specified, the default is afterFieldLabel. |
| fieldTrailerWrapperName | This is the name of the data wrapper for the string that is appended after the field data. If not specified, the default is fieldTrailer. |
| lineBreak | This is a line break character. |
For more complete information about AddRecordData and the other formatting classes, see the Javadoc.
See Also