ORG.oclc.fmts.rules
Class AddBriefHoldings

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

public class AddBriefHoldings

extends RuleUtil

implements DisplayRule

The AddBriefHoldings class is a record formatting rule that creates a 'brief' MARC holdings display containing only the Location, Call-Number, Collection, and Notes data when available. 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:

addLabels

A true/false flag to indicate whether the data labels should be added to the output data, where the default is true. If the flag is off, only the wrapper data elements are added and the labels are ommitted.

tableDisplay

A true/false flag to indicate whether a space should be added into the formatting buffer when the holdings data item is not found, this would be of use when making a table display of the data so the columns stay in line. the default setting is false. there is not rule displayname value, where the default is false.

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 null.

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 null.

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 null.

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

See Also:

RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary

AddBriefHoldings()

Method Summary

boolean	appendData(FormatBerUtil fmtUtil, String data, String label, String b4Label, String afterLabel, String sep, boolean addSep, boolean addLabels, boolean tableDisplay)
void	doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Adds the formatted brief holdings data from the input record to the format buffer held in the input FormatBerUtil 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

AddBriefHoldings

public AddBriefHoldings()

Method Detail

doRule

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

Adds the formatted brief holdings data from the input record to the format buffer held in the input FormatBerUtil 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.

appendData

public boolean appendData(FormatBerUtil fmtUtil,
                          String data,
                          String label,
                          String b4Label,
                          String afterLabel,
                          String sep,
                          boolean addSep,
                          boolean addLabels,
                          boolean tableDisplay)