Open SiteSearch 4.1.1
Final

ORG.oclc.gadgets
Class FormatRecordsWithDuplicates

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

public class FormatRecordsWithDuplicates
extends FormatRecordsAndAttachHoldings

The FormatRecordsWithDuplicates class is a gadget that invokes a database record formatting class to be executed on the object in the user state named UnformattedRecordData containing a Vector of unformatted record data objects in order to create an HTML string representation of the data. 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.

The parameters to the gadget are:
fmt - the name of the formatting class to use such as 'brief', 'full', or 'bookmark' for the representative record. This is specified in the [Formats] section of the individual database configuration file.
DuplicatesFmt - the name of the formatting class for formatting duplicates.
tempDb - flag to indicate that the gadget will format records from a temporary database search (tdbname) where true indicates temporary.
norecordsmessage - text to display when there are no raw records where the default is an empty string("").

See Also:
UserStateObject, WebZFormatter

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
FormatRecordsWithDuplicates()
          Constructs a FormatRecordsWithDuplicates object.
 
Method Summary
 String buildit(RequestManager rMngr, String name)
          Generates a String containing the HTML for the data record generated by the database formatting class using the parameters containined in the RequestManager object and the name of the gadget.
 String toString()
          Generates a String representation of the object.
 
Methods inherited from class ORG.oclc.gadgets.FormatRecordsAndAttachHoldings
attachHoldings, getHoldings
 
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

FormatRecordsWithDuplicates

public FormatRecordsWithDuplicates()
Constructs a FormatRecordsWithDuplicates object.
Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)
Generates a String containing the HTML for the data record generated by the database formatting class 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 FormatRecordsAndAttachHoldings

toString

public String toString()
Generates a String representation of the object.
Returns:
String
Overrides:
toString in class FormatRecordsAndAttachHoldings

Open SiteSearch 4.1.1
Final