ORG.oclc.gadgets
Class BookMarkBrief

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

Direct Known Subclasses:

BookMarkEmail

public class BookMarkBrief

extends FormatRecords

The BookMarkBrief class is a gadget creates the HTML string for the brief display of bookmarked records. 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:
fmtclass - the name of the formatting class to use such as 'bookmarkbrief'. This is specified in the [Formats] section of the individual database configuration file.

BookMarkBrief retrieves the BookMarkEntry objects saved in the user state object to create the HTML output. For efficiency purposes, the brief bookmark display for each record is created only once. If the record has not been formatted, the formatting class is executed for the raw database record and saved for re-use.

See Also:

UserStateObject, WebZFormatter, FormatRecords, BookMarkEntry

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

BookMarkBrief()
Constructs a BookMarkBrief object.

Method Summary

String	buildit(RequestManager rMngr, String name) Generates a String containing the HTML for the brief bookmark records using the parameters containined in the RequestManager object and the name of the gadget.
protected String	getFormattedBookMark(BookMarkEntry entry, String fmtName, DataPairs dataWrappers)
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

BookMarkBrief

public BookMarkBrief()

Constructs a BookMarkBrief object.

Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)

Generates a String containing the HTML for the brief bookmark records 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

getFormattedBookMark

protected String getFormattedBookMark(BookMarkEntry entry,
                                      String fmtName,
                                      DataPairs dataWrappers)

toString

public String toString()

Generates a String representation of the object.

Returns:

String

Overrides:

toString in class FormatRecords