ORG.oclc.gadgets
Class FormatRecordsAndAttachHoldings

java.lang.Object
  |
  +--ORG.oclc.gadgets.FormatRecords
        |
        +--ORG.oclc.gadgets.FormatRecordsAndAttachHoldings

Direct Known Subclasses:

FormatRecordsWithDuplicates

public class FormatRecordsAndAttachHoldings

extends FormatRecords

The FormatRecordsAndAttachHoldings class is a gadget that searches a holdings database associated with the display database records to retrieve associated holdings data and attach it to the citation record so that the FormatRecord gadget can create an HTML string containing both the citation data and the associated holdings information. It uses the parameters contained in a RequestManager object and the parameters for the gadget read from the configuration files to build the appropriate output. If an error occurs, an empty string("") is returned.

If there is not a holdings database associated with the display records or the format of display is a brief display, the holdings attachment process is by-passed.

The parameters to the gadget are:
fmtclass - the name of the formatting class in the holdings database to use such as 'full'. This is specified in the [Formats] section of the holdings database configuration file.
searchKeyFmt - the name of the formatting class in the citation database that creates the search key string for searching the holdings database found in the [Formats] section of the citation database configuration file.
numrecs - the number of holdings records to retrieve
tempDb - flag to indicate that the gadget will format records from a temporary database search (tdbname) where true indicates temporary.

The holdings database query is set up as a 'temporary' database search so that the user's current state is preserved. The record formatting is performed by the parent class FormatRecords.

See Also:

UserStateObject, WebZFormatter, FormatRecords

Fields inherited from class ORG.oclc.gadgets.FormatRecords

dataWrappers, dbname, displayGadget, errormsg, fmtName, gadgetInfo, initted, numHoldings, recno, recordData, recordformat, resultset, returnedRecs, searchKeyFmt, user, zDb, zUserData

Constructor Summary

FormatRecordsAndAttachHoldings()
Constructs a FormatRecordsAndAttachHoldings object.

Method Summary

boolean	attachHoldings(RequestManager rMngr, Vector rawRecords, String searchKeyFmt, String numHoldings)
String	buildit(RequestManager rMngr, String name) Generates a String containing the HTML for the holdings records associated with the input citation using the parameters containined in the RequestManager object and the name of the gadget.
protected void	getHoldings(RequestManager rMngr, String gadgetName)
String	toString() Generates a String representation of the object.

Methods inherited from class ORG.oclc.gadgets.FormatRecords

formatPresentData, getDataWrappers, init, runFormat, runFormat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FormatRecordsAndAttachHoldings

public FormatRecordsAndAttachHoldings()

Constructs a FormatRecordsAndAttachHoldings object.

Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)

Generates a String containing the HTML for the holdings records associated with the input citation using the parameters containined in the RequestManager object and the name of the gadget.

Parameters:

rMngr - object containing input parameters for the request.

name - the name of the gadget - the section name in the configuration file defining the particular gadget.

Returns:

String

Overrides:

buildit in class FormatRecords

getHoldings

protected final void getHoldings(RequestManager rMngr,
                                 String gadgetName)

attachHoldings

public final boolean attachHoldings(RequestManager rMngr,
                                    Vector rawRecords,
                                    String searchKeyFmt,
                                    String numHoldings)

toString

public String toString()

Generates a String representation of the object.

Returns:

String

Overrides:

toString in class FormatRecords