Open SiteSearch 4.1.1
Final

ORG.oclc.fmts.obi
Class MarcArticleBookmarkFullFmt

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

public class MarcArticleBookmarkFullFmt
extends MarcArticleFmt

The MarcArticleBookmarkFullFmt class formats bookmark records in full format for display in the WebZ interface.

MarcArticleBookmarkFullFmt uses the userObject and a Vector of records to return a formatted String that contains the text to display.

NOTE: THIS IS NOT IN HTML like the other MarcArticleFmt classes. This text can also be sent in an email message and that cannot be HTML.

This class is an extension (through MarcArticleFmt) 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 MarcArticleBookmarkFullFmt results in text that can be displayed in the WebZ interface and sent in an email. Unsuccessful execution will result in a null String being returned.

Within doFormat, for each DataDir in the Vector, formatRecord is called to format the contained fields. All of the formatting of the individual fields is done in MarcArticleFmt class.



Fields inherited from class ORG.oclc.fmts.obi.MarcArticleFmt
abstractTag, author, authorAllSubFields, authorFields, authorHotlinkAllTag, authorHotlinkTag, authorIndexTag, authorNotHotSubFields, authorSeparator, authorTerminator, begLabel, bufSize, CODENTag, countryTag, databaseNoTag, documentTypeTag, endLabel, from, fromField1, fromField2, fromFields, fromISSNTag, fromSubFields1, fromSubFields2, govDocNoTag, header, includeField, includeFieldTerminator, includeSubFields, includeSubFieldTerminator, ISBNTag, ISSN, ISSNTag, languageTag, linkData, meetingFields, meetingTag1, meetingTag2, noteField, noteSubFields, orgFields, orgTag1, orgTag2, publisherTag, recordTypeTag, subjectField600, subjectField610, subjectField650, subjectField651, subjectField690, subjectFields, subjectIndexTag, subjectSubFieldTerminator, title, trailer, yearTag
 
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
MarcArticleBookmarkFullFmt()
           Constructs a MarcArticleBookmarkFullFmt object.
 
Method Summary
 String doFormat(Object userObject, Vector records)
           Formats the bookmark records for display in the WebZ interface.
 
Methods inherited from class ORG.oclc.fmts.obi.MarcArticleFmt
addAbstract, addAuthor, addCODEN, addCountry, addDatabaseNo, addDocumentType, addFrom, addGovDocNo, addIncludes, addISBN, addISSN, addLanguage, addLibraries, addMeeting, addNotes, addOrganization, addPublisher, addRecordType, addSubjects, addTitleBookMark, addYear, labelMaker
 
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
 

Constructor Detail

MarcArticleBookmarkFullFmt

public MarcArticleBookmarkFullFmt()

Constructs a MarcArticleBookmarkFullFmt object.


Method Detail

doFormat

public String doFormat(Object userObject,
                       Vector records)

Formats the bookmark records for display in the WebZ interface.

Since HTML is not being generated, the label, header and trailer variables are set to strings compatible with straight text output.

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

Open SiteSearch 4.1.1
Final