ORG.oclc.fmts.rules
Class AddILLData

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

public class AddILLData

extends RuleUtil

implements DisplayRule

The AddILLData class is a record formatting rule that creates data fields for an Interlibrary Loan Request(ILL). It locates the data for the input field specification and stores it in the user state object in the entity name specified by the rule parameter 'IllEntity'. If the data is also displayed on the ILL form in the interface, it is added to the formatted data buffer and is delimeted by the HTML specifications defined in the DisplayUserData object.

The parameters this rule recognizes are:

IllEntity

The name of the entity to store the field data in the user state object.

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.

See Also:

RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary

AddILLData()

Method Summary

void

doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Retrieves the data from the input record according to the fields specified in the input RuleSpec object, stores it in the user state, and also adds the data to the formatting buffer if a display label is provided for the field in the RuleSpec.

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

AddILLData

public AddILLData()

Method Detail

doRule

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

Retrieves the data from the input record according to the fields specified in the input RuleSpec object, stores it in the user state, and also adds the data to the formatting buffer if a display label is provided for the field in the RuleSpec.

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.