Open SiteSearch 4.1.1
Final

ORG.oclc.fmts.obi
Class UListCopiesFmt

java.lang.Object
  |
  +--ORG.oclc.fmts.WebZFormatter
        |
        +--ORG.oclc.fmts.obi.UListCopiesFmt

public class UListCopiesFmt
extends WebZFormatter

The UListCopiesFmt class formats records from the Union Lists (a FirstSearch database) for display in the WebZ interface. The displayed record will contain location holdings information.

UListCopiesFmt uses the userObject and a Vector of records to return a formatted String that contains the HTML to display. This class is an extension of WebZFormatter which implements the RecordFormatter interface. That interface requires a doFormat method to do the work on the input userObject and a Vector of DataDirs.

Successful execution of UListCopiesFmt results in HTML that can be displayed in the WebZ interface. Unsuccessful execution will result in a null String being returned.


Field Summary
protected  String begLabel
           String containing the characters to be used before the label text - usually HTML
protected  String endLabel
           String containing the characters to be used after the label text - usually HTML
protected  String trailer
           String containing the label to be used at the end of a field
 
Fields inherited from class ORG.oclc.fmts.WebZFormatter
bookMarkFont, context, currecno, defaultTextFont, fmtUtil, fullrecno, j, otherWidgets, queryBad, queryNext, queryTarget, resultset, smallTextFont, styles, tempRecords, toprecno, user
 
Constructor Summary
UListCopiesFmt()
          Constructs a UListCopiesFmt object.
 
Method Summary
 String doFormat(Object userObject, Vector records)
           Formats the records for display in the WebZ interface from the Union Lists database.
 
Methods inherited from class ORG.oclc.fmts.WebZFormatter
addBookMark, addBookMark, addBookMark, init
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

begLabel

protected String begLabel

String containing the characters to be used before the label text - usually HTML


endLabel

protected String endLabel

String containing the characters to be used after the label text - usually HTML


trailer

protected String trailer

String containing the label to be used at the end of a field

Constructor Detail

UListCopiesFmt

public UListCopiesFmt()
Constructs a UListCopiesFmt object.
Method Detail

doFormat

public String doFormat(Object userObject,
                       Vector records)

Formats the records for display in the WebZ interface from the Union Lists database.

Parameters:
userObject - the UserStateObject object for the current user.
records - a vector of bookmark records to be formatted
Returns:
String contains the HTML representation of the records
Overrides:
doFormat in class WebZFormatter

Open SiteSearch 4.1.1
Final