Open SiteSearch 4.1.1
Final

ORG.oclc.fmts.obi
Class MarcArticleBriefFmt

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

public class MarcArticleBriefFmt
extends MarcArticleFmt

The MarcArticleBriefFmt class formats records for display in the WebZ interface using a subset of the full format.

MarcArticleBriefFmt 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 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 MarcArticleBriefFmt 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. Most of the fields are formatted by methods in MarcArticleFmt. However, the following fields are formatted by specific methods in this class:

Year (by addYear)


Field Summary
protected static String yearID
           String containing the characters to be stripped if found as part of the data
protected static String yearLabel
           String containing the label to be displayed before the year
protected static String yearTag1
           String containing the BER tag for the predominant year field If this field is found in the record, it is used as the source of the year field.
protected static String yearTag2
           String containing the BER tag for the secondary year field If the predominant year tag is not found in the record, this tag is used as the source of the year field.
 
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
MarcArticleBriefFmt()
           Constructs a MarcArticleBriefFmt object.
 
Method Summary
protected  void addYear(DataDir dir)
           Formats the year field and adds it to the HTML Specifications for the year field: 260/3 773/7 Only use the 773/7 if 260/3 is not present
 String doFormat(Object userObject, Vector records)
           Formats the records for display in the WebZ interface using a subset of the full format.
 
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
 

Field Detail

yearLabel

protected static final String yearLabel

String containing the label to be displayed before the year


yearTag1

protected static final String yearTag1

String containing the BER tag for the predominant year field

If this field is found in the record, it is used as the source of the year field.


yearTag2

protected static final String yearTag2

String containing the BER tag for the secondary year field

If the predominant year tag is not found in the record, this tag is used as the source of the year field.


yearID

protected static final String yearID

String containing the characters to be stripped if found as part of the data

Constructor Detail

MarcArticleBriefFmt

public MarcArticleBriefFmt()

Constructs a MarcArticleBriefFmt object.

Method Detail

doFormat

public String doFormat(Object userObject,
                       Vector records)

Formats the records for display in the WebZ interface using a subset of the full format.

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

addYear

protected void addYear(DataDir dir)

Formats the year field and adds it to the HTML

Specifications for the year field:
260/3
773/7
Only use the 773/7 if 260/3 is not present
Parameters:
dir - a DataDir that contains the bookmark record to be formatted
recno - an integer that contains the current record number for display of the the title.
Returns:
void

Open SiteSearch 4.1.1
Final