Open SiteSearch 4.1.1
Final

ORG.oclc.gadgets
Class BookMarkFull

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

public class BookMarkFull
extends FormatRecords

The BookMarkFull class is a gadget creates the HTML string for the full 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 or fmt - the type of format to use such as 'bookmarkfull'. This is specified in the [Formats] section of the individual database configuration file.
addUnsave - flag indicating whether to append the unsave the bookmark button on the output where true indicates to do so.

BookMarkFull retrieves the BookMarkEntry objects saved in the user state object to create the HTML output. Each bookmarked record has been written to the user's temp directory. Each raw record is read from disk and is formatted using the formatting class specified in the gadget.

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
BookMarkFull()
          Constructs a BookMarkFull object.
 
Method Summary
 String buildit(RequestManager rMngr, String name)
          Generates a String containing the HTML for the full bookmark records using the parameters containined in the RequestManager object and the name of the gadget.
protected  String getFormattedBookMark(BookMarkEntry entry, String fmtName, String duplicatesFmt, DataPairs dataWrappers)
           
 String getFormattedBookMark(UserStateObject user, String name, BookMarkEntry entry)
           
protected  BerString readRec(String fileName)
           
 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

BookMarkFull

public BookMarkFull()
Constructs a BookMarkFull object.
Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)
Generates a String containing the HTML for the full 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

public String getFormattedBookMark(UserStateObject user,
                                   String name,
                                   BookMarkEntry entry)

getFormattedBookMark

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

readRec

protected BerString readRec(String fileName)

toString

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

Open SiteSearch 4.1.1
Final