ORG.oclc.fmts.rules
Class AddHoldings

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

public class AddHoldings

extends RuleUtil

implements DisplayRule

The AddHoldings class is a record formatting rule that creates a MARC holdings display for the input record. The HTML or Text specifications defined in the DisplayUserData object are used to delimit data found in the input record to create the formatted text.

The parameters recognized by this rule are:

recordSourceLabel

The label to attach to indicate the database from which the holdings entry was retrieved. If this is ommitted, the record source is not added to the holdings display information.

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 Holdings data for duplicate records. If this parameter is supplied, any data held in the input entity name is appended to the formatting buffer.

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:

hldStartLbl

String appended before the label of a holdings item

hldEndLbl

String appended after the label of a holdings item

hldFldSep

String used to separarate the items within a holdings entry

hldSep

String used used to separate multiple holdings

hldStatusLblStart

String appended before the label of a holdings status item

hldStatusLblEnd

String appended after the label of a holdings status item

hldStatusFldSep

String appeneded between items within a holdings status item

hldStatusEnd

String appended after the holdings status item data

See Also:

RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary

AddHoldings()

Method Summary

void	doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Adds a holdings display to the output formatting buffer based on the specific Marc holdings found in the data.

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

AddHoldings

public AddHoldings()

Method Detail

doRule

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

Adds a holdings display to the output formatting buffer based on the specific Marc holdings found in the data.

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.