ORG.oclc.fmts.rules
Class HoldingsSearchKey

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

public class HoldingsSearchKey

extends RuleUtil

implements DisplayRule

The HoldingsSearchKey class is a record formatting rule that creates a string containing a search key that can be used to create a separate search to retrieve holdings information for a record, as in the DRA model where the holdings are found in a separate database. The FormatRecordsAndAttachHoldings gadget makes use of this rule.

The parameters this rule recognizes are:

holdingsIdentifier

The text that is appended to input record to identify the type of holdings that can be attached. The AddHoldings rule examines this field to determine how to format the holdings data. An example of a holdings Identifier string is DRAHOLDINGS.

indexid

the indexid to use for the search key data, such as 'hk:' found in the DRAHOLDINGS database.

See Also:

RuleSpec, FormatBerUtil, DisplayUserData

Constructor Summary

HoldingsSearchKey()

Method Summary

void

doRule(DataDir dir, int recordNumber, RuleSpec ruleSpec, FormatBerUtil fmtUtil, DisplayUserData userData) Creates a string containing a search key for that is used to create a search to a database such as the DRA Holdings database to retrieve the holdings data to attach to the record for holdings display.

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

HoldingsSearchKey

public HoldingsSearchKey()

Method Detail

doRule

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

Creates a string containing a search key for that is used to create a search to a database such as the DRA Holdings database to retrieve the holdings data to attach to the record for holdings display.

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.