Open SiteSearch 4.1.1 Final API Specification: Class MarcCatalogBookmarkFmt

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Open SiteSearch 4.1.1
Final

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ORG.oclc.fmts.obi
Class MarcCatalogBookmarkFmt

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

public class MarcCatalogBookmarkFmt
extends MarcCatalogFmt

The MarcCatalogBookmarkFmt class formats bookmark records for display in the WebZ interface.

MarcCatalogBookmarkFmt uses the userObject and a Vector of records to return a formatted String that contains the HTML to display. 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 MarcCatalogBookmarkFmt results in HTML that can be displayed in the WebZ interface. 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. Since this is such a simple and specialized display, none of the formating is defined in the 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
`MarcCatalogBookmarkFmt()` Constructs a MarcCatalogBookmarkFmt object.

Method Summary
`String`	`doFormat(Object userObject, Vector records)` Formats 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

MarcCatalogBookmarkFmt

public MarcCatalogBookmarkFmt()

Constructs a MarcCatalogBookmarkFmt object.

Method Detail

doFormat

public String doFormat(Object userObject,
                       Vector records)

Formats bookmark records for display in the WebZ interface.

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