ORG.oclc.fmts.rules
Class AddILLSendToList

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

public class AddILLSendToList

extends RuleUtil

implements DisplayRule

The AddILLSendToList class is a record formatting rule that creates a String containing a sendToList of blank-delimited OCLC symbols and saves it in the user state for an Interlibrary Loan Request(ILL). It uses the data from the record found in the holdings field and subfields specified for the rule, such as field 1002/0/2 and subfield 9, to to perform a lookup of the lender string in the input location symbols configuration files.

The parameters this rule recognizes are:

IllEntity

The name of the entity to store the OCLC number in. "BibSendToList".

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

AddILLSendToList()

Method Summary

void	doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Creates the sendToList and saves it in the user state object for the input record and 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

AddILLSendToList

public AddILLSendToList()

Method Detail

doRule

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

Creates the sendToList and saves it in the user state object for the input record and 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.