ORG.oclc.fmts.rules
Class AddRecordData

java.lang.Object
  |
  +--ORG.oclc.fmts.rules.RuleUtil
        |
        +--ORG.oclc.fmts.rules.AddRecordData

Direct Known Subclasses:

AddLocalHoldingsButton

public class AddRecordData

extends RuleUtil

implements DisplayRule

The AddRecordData class is the DEFAULT record formatting rule that creates a formatted string from the data fields specified in the RuleSpec and uses the the HTML or Text specifications defined in the DisplayUserData object to delimit the data found in the input record.

The parameters recognized by this rule are:

command

The QUERY command to use when there is an index specified in the descriptiotn to create a query, where the default, if not specified, is &StyleTable.defaults.QueryCommand;.

cleanUpQuery

A true/false value indicating whether any filtering should be done by the formatting class on the data that goes into the query anchor. The default value is true.

nextPage

The next= page in the anchor, where the default, if not specified, is &StyleTable.pages.searchResults;.

badPage

The bad= page in the anchor, where the default, if not specified, is &StyleTable.pages.badquery;.

queryWidgets

Widgets to add to the query, where the default, if not specified is entitytoprecno=1&entitycurrecno=1&numrecs=&srchnumrecs;.

target

The target value for the anchor where the default, if not specified, is &StyleTable.targets.searchResults;.

saveInEntityName

The user state entity name to store the formatted string created by this rule. If not specified, the data is appended to the formatting buffer.

dupEntityName

The entity name containing the formatted duplicate data field. If this parameter is supplied, any data held in the input entity name is appended to the formatting buffer and is removed from the user state.

beforeLabelWrapperName

The name of the data wrapper entry that has the string to append before the field display label, default, if not specified, is the wrapper element named beforeFieldLabel.

afterLabelWrapperName

The name of the data wrapper entry that has the string to append after the field display label, where the default, if not specified, is the wrapper element named afterFieldLabel.

fieldTrailerWrapperName

The name of the data wrapper entry that has the string to append after the field data, where the default, if not specified, is the wrapper element named fieldTrailer.

The special wrapper data entries that are recognized:

lineBreak

the line break character

See Also:

RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary

AddRecordData()

Method Summary

void	doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Appends formatted record data for the input record according to the specifications found in the input RuleSpec object.

Methods inherited from class ORG.oclc.fmts.rules.RuleUtil

appendEntityData, getData, getData, getWrapperData, getWrapperData, getWrapperDataFromRuleParm, labelMaker, saveDataInEntity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddRecordData

public AddRecordData()

Method Detail

doRule

public void doRule(DataDir dir,
                   int recordNumber,
                   RuleSpec ruleSpec,
                   FormatBerUtil fmtUtil,
                   DisplayUserData userData)

Appends formatted record data for the input record according to the specifications found in the input RuleSpec object.

Specified by:

doRule in interface DisplayRule

Parameters:

dir - the DataDir object containing the data record

recordNumber - the record number of the item within the list

ruleSpec - the field specification for locating the data

fmtUtil - the FormatBerUtil object containing the current formatted data buffer and the formatting utilities.

userData - the DisplayUserData object containing the user's context for formatting the data records.