Open SiteSearch 4.1.1
Final

ORG.oclc.fmts.obi
Class MarcCatalogBookmarkFullFmt

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

public class MarcCatalogBookmarkFullFmt
extends MarcCatalogFmt

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

MarcCatalogBookmarkFullFmt 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 MarcCatalogFmt classes. This text can also be sent in an email message and that cannot be HTML.

This class is an extension (through MarcCatalogFmt) 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 MarcCatalogBookmarkFullFmt 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 MarcCatalogFmt class.



Fields inherited from class ORG.oclc.fmts.obi.MarcCatalogFmt
abstractTag, alternateTitleFields, alternateTitleSubfields, author, authorBreakSubfield110_710, authorField100, authorField110, authorField700, authorField710, authorFields, authorFldid100, authorFldid110, authorFldid700, authorFldid710, authorHotSubfields100, authorHotSubfields110_710, authorHotSubfields700, authorIndex, authorNotHotSubfields100, authorNotHotSubfields110_710, authorNotHotSubfields700, authorSeparator, authorTerminator, begLabel, bufSize, conferenceFields, conferenceHotSubfields, conferenceIndex, conferenceNotHotSubfields, conferenceSeparator, conferenceTerminator, contentsBreakSubfield, contentsField, contentsFldid505, contentsSeparator, contentsSubfields, contentsTerminator, descriptorsField, descriptorsHotSubfields, descriptorsNotHotSubfields, editionTag, endLabel, frequencyTag, from, header, ISBNTag, ISSN, ISSNTag, lineBreak, linkData, noteBreakSubfield, noteFields, noteNotHotSubfields, noteSeparator, noteTerminator, organizationSubjectBreakSubfield, organizationSubjectField, organizationSubjectHotSubfields, organizationSubjectNotHotSubfields, performersTag, personSubjectField, personSubjectHotSubfield, personSubjectNotHotSubfields, physDescTags, publicationBreakSubfield, publicationDatesTag, publicationFields, publicationSeparator, publicationSubfields, publicationTerminator, seriesBreakSubfield, seriesFields, seriesFldid400, seriesFldid410, seriesFldid411, seriesFldid440, seriesFldid490, seriesFldid800, seriesFldid810, seriesFldid830, seriesSeparator, seriesSubfields400_800, seriesSubfields410_810, seriesSubfields411, seriesSubfields440, seriesSubfields490, seriesTerminator, subheadingSeparator, subjectHeadingsBreakSubfield651_652, subjectHeadingsFields, subjectHeadingsFldid650, subjectHeadingsFldid651, subjectHeadingsFldid652, subjectHeadingsFldid690, subjectHeadingsHotSubfields650_690, subjectHeadingsHotSubfields651_652, subjectHeadingsNotHotSubfields, subjectIndex, subjectSeparator, subjectSubheadingSubfields, subjectTerminator, title, titleField, titleField245, titleFldid245, titleHotSubfields245, titleIndex, titleNotHotSubfields245, titleSeparator, titleTerminator, trailer, uniformTitleFields, uniformTitleSubfields, uniformTitleSubjectField, uniformTitleSubjectHotSubfield, uniformTitleSubjectNotHotSubfields
 
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
MarcCatalogBookmarkFullFmt()
           Constructs a MarcCatalogBookmarkFullFmt 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.MarcCatalogFmt
addAbstract, addAlternateTitle, addAuthor, addBriefHoldings, addConference, addContents, addDescriptors, addEdition, addFrequency, addHoldings, addHoldings, addHoldings, addISBN, addISSN, addLibraries, addOrganizationsAsSubjects, addOtherNotes, addPerformers, addPersonsAsSubjects, addPhysDesc, addPublication, addPublicationDates, addSeries, addSubjectHeadings, addTitle, addUniformTitle, addUniformTitleAsSubject, createHoldings, 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

MarcCatalogBookmarkFullFmt

public MarcCatalogBookmarkFullFmt()

Constructs a MarcCatalogBookmarkFullFmt 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