ORG.oclc.fmts.rules
Class AddILLDatabaseName

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

public class AddILLDatabaseName

extends RuleUtil

implements DisplayRule

The AddILLDatabaseName class is a record formatting rule that saves the name of the database for the input record in the user state for an Interlibrary Loan Request(ILL).

The parameters this rule recognizes are:

IllEntity

The name of the entity to store the database name value in the user state object. i.e. "BibVerification".

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

AddILLDatabaseName()

Method Summary

void

doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Stores the database name of the input record in the user state in the entity specificied by the rule parameter 'IllEntity', and and also adds the name to the formatting buffer if a display label is provided for 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

AddILLDatabaseName

public AddILLDatabaseName()

Method Detail

doRule

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

Stores the database name of the input record in the user state in the entity specificied by the rule parameter 'IllEntity', and and also adds the name to the formatting buffer if a display label is provided for 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.