ORG.oclc.fmts.obi
Class MarcArticleFmt

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

Direct Known Subclasses:

MarcArticleBookmarkFmt, MarcArticleBookmarkFullFmt, MarcArticleBriefFmt, MarcArticleFullFmt, MarcArticleMultiFullFmt, MarcContentsFrstFullFmt, MarcContentsFrstMultiFullFmt, MarcOvidFullFmt, MarcOvidMultiFullFmt, MarcPapersFrstBookmarkFullFmt, MarcPapersFrstFullFmt, MarcPapersFrstMultiFullFmt

public class MarcArticleFmt

extends WebZFormatter

The MarcArticleFmt class provides a set of formatting methods for use by MarcArticle*Fmt classes.

MarcArticleFmt does not use its input since its doFormat routine does nothing but call its superClass's doFormat. This class should never be called except through its subclasses. .

Successful execution of MarcArticleBookmarkFmt results in an empty string similar to WebZformatter. Unsuccessful execution will result in a null String being returned.

Field Summary

protected static String	abstractTag String containing abstract tag (520/1)
protected String	author String containing the record's author (using for Holdings retrieval)
protected static String	authorAllSubFields String containing a list of subfields to be used for authors when no hot link is generated
protected static String	authorFields String containing the BER field tags for authors (100, 700)
protected static String	authorHotlinkAllTag String containing the tags for the author fields to be hotlinked (100/1, 700/1)
protected static String	authorHotlinkTag String containing the tag for the author field to be hotlinked (100/1)
protected static String	authorIndexTag String containing the author index tag
protected static String	authorNotHotSubFields String containing a list of subfields to be used for non-hotlinked portion of the author display
protected static String	authorSeparator String containing the separator for authors
protected static String	authorTerminator String containing the terminator for authors
protected String	begLabel String containing the characters to be used before the label text - usually HTML
protected static int	bufSize String containing the default StringBuffer size
protected static String	CODENTag String containing CODEN tag (030/1)
protected static String	countryTag String containing country tag (260/1)
protected static String	databaseNoTag String containing the databaseNo tag (069/1)
protected static String	documentTypeTag String containing the documentType tag (073/1)
protected String	endLabel String containing the characters to be used after the label text - usually HTML
protected String	from String containing the record's from field (using for Holdings retrieval)
protected static String	fromField1 String containing the first from field tag (773)
protected static String	fromField2 String containing the second from field tag (510)
protected static String	fromFields String containing both from field tags (773, 510)
protected static String	fromISSNTag String containing the ISSN tag within the from field (773/24)
protected static String	fromSubFields1 String containing the subfields that follow the first from tag (773)
protected static String	fromSubFields2 String containing the subfields that follow the second from tag (510)
protected static String	govDocNoTag String containing the govDocNo tag (074/1)
protected String	header String containing the characters to be used at the beginning of a line without a label
protected static String	includeField String containing the include field tag (505)
protected static String	includeFieldTerminator String containing the include terminator
protected static String	includeSubFields String containing the include subfields (*)
protected static String	includeSubFieldTerminator String containing include subfield terminator
protected static String	ISBNTag String containing ISBN tag (020/1)
protected String	ISSN String containing the record's ISSN (using for Holdings retrieval)
protected static String	ISSNTag String containing ISSN tag (022/1)
protected static String	languageTag String containing language tag (546/1)
protected String	linkData String containing information for a hotlink
protected static String	meetingFields String containing the tags for meetings (411, 811)
protected static String	meetingTag1 String containing the tag for the first meeting field (411/1)
protected static String	meetingTag2 String containing the tag for the second meeting field (811/1)
protected static String	noteField String containing the note field tag (500)
protected static String	noteSubFields String containing the note subfields tag (*)
protected static String	orgFields String containing the tags for organizations (110/410)
protected static String	orgTag1 String containing the tag for the first organization (110/1,2)
protected static String	orgTag2 String containing the tag for the second organization (410/1,2)
protected static String	publisherTag String containing the publisher tag (260/2)
protected static String	recordTypeTag String containing the recordType (945/1)
protected static int	subjectField600 Integer containing the fldid for subject field 600
protected static int	subjectField610 Integer containing the fldid for subject field 610
protected static int	subjectField650 Integer containing the fldid for subject field 650
protected static int	subjectField651 Integer containing the fldid for subject field 651
protected static int	subjectField690 Integer containing the fldid for subject field 690
protected static String	subjectFields String containing the subject tags (650, 651, 600, 610, 690)
protected static String	subjectIndexTag String containing the subject index tag
protected static String	subjectSubFieldTerminator String containing the subject field terminator
protected String	title String containing the record's title (using for Holdings retrieval)
protected String	trailer String containing the label to be used at the end of a field
protected static String	yearTag String containing the year tag (260/3)

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

MarcArticleFmt()
Constructs a MarcArticleFmt object.

Method Summary

protected void	addAbstract(DataDir dir, boolean useLabel) Formats the abstract and adds it to the HTML Specifications for the abstract field: 520/1
protected void	addAuthor(DataDir dir, boolean useLabel, boolean useTrailer, boolean createHotLink) Formats the authors and add them to the HTML Specifications for the author fields: 100/1,17,4,2,3,5,6 700/1,17,4,2,3,5,6 Make 100/1 a hotlink with au: as the indextag Use period "." as a terminator Use period space space ".
protected void	addCODEN(DataDir dir, boolean useLabel) Formats the CODEN and adds it to the HTML Specifications for the CODEN field: 030/1
protected void	addCountry(DataDir dir, boolean useLabel) Formats the country and adds it to the HTML Specifications for the language field: 260/1
protected void	addDatabaseNo(DataDir dir, boolean useLabel) Formats the database number field and adds it to the HTML Specifications for the database number field: 069/1
protected void	addDocumentType(DataDir dir, boolean useLabel) Formats the document type and adds it to the HTML Specifications for the document type field: 073/1
protected void	addFrom(DataDir dir, boolean useLabel) Formats the from fields and adds them to the HTML Specifications for the from fields: 773/20,19,1,7,4,24 510,1,2,30 When displaying the 773 fields, add " ISSN: " before subfield 24
protected void	addGovDocNo(DataDir dir, boolean useLabel) Formats the government document number and adds it to the HTML Specifications for the government document number field: 074/1
protected void	addIncludes(DataDir dir, boolean useLabel) Formats the includes and adds them to the HTML Specifications for the includes field: 505/'*' Use period space dash dash (".
protected void	addISBN(DataDir dir, boolean useLabel, boolean useTrailer) Formats the ISBN and adds it to the HTML Specifications for the ISBN field: 020/1
protected void	addISSN(DataDir dir, boolean useLabel, boolean useTrailer, boolean createHoldingsLink, int whichRecord) Formats the ISSN and adds it to the HTML Specifications for the ISSN field: 022/1 Generate a link to the holdings using the author, title, and from information.
protected void	addLanguage(DataDir dir, boolean useLabel) Formats the language and adds it to the HTML Specifications for the language field: 546/1
protected void	addLibraries(DataDir dir, boolean useLabel, boolean useHTML) Formats the libraries field and adds it to the string being built Specifications for the libraries field: 948/8
protected void	addMeeting(DataDir dir, boolean useLabel) Formats the meetings and adds them to the HTML Specifications for the meeting fields: 411/1 811/1
protected void	addNotes(DataDir dir) Formats the notes and adds them to the HTML Specifications for the notes field: 500/'*' Output in data order Characters before a ':' become the label Characters after a ':' become the data in the field Fields go on a new line
protected void	addOrganization(DataDir dir, boolean useLabel) Formats the organizations and adds them to the HTML Specifications for the organization fields: 110/1-2 410/1-2
protected void	addPublisher(DataDir dir, boolean useLabel) Formats the publisher and adds it to the HTML Specifications for the publisher field: 260/2
protected void	addRecordType(DataDir dir, boolean useLabel) Formats the record type and adds it to the HTML Specifications for the record type field: 945/1
protected void	addSubjects(DataDir dir, boolean useLabel, boolean createHotLink) Formats the subjects and adds them to the HTML Specifications for the ISBN field: 020/1 650/1,2,24,25,26 651/1,2,24,25,26 600/1,2,3,8,14,15,24,25,26 610/1,2,24,25,26 690/1 Make all subfields hot individually Use sh: as the hotlink index
protected void	addTitleBookMark(DataDir dir, int whichRecord, String fields, String fields2, String label) Adds a title with bookmark widgit
protected void	addYear(DataDir dir, boolean useLabel, boolean useTrailer) Formats the year field and adds it to the HTML Specifications for the year field: 260/3
protected String	labelMaker(String text) Creates a label from some text

Methods inherited from class ORG.oclc.fmts.WebZFormatter

addBookMark, addBookMark, addBookMark, doFormat, 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

header

protected String header

String containing the characters to be used at the beginning of a line without a label

trailer

protected String trailer

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

linkData

protected String linkData

String containing information for a hotlink

title

protected String title

String containing the record's title (using for Holdings retrieval)

author

protected String author

String containing the record's author (using for Holdings retrieval)

ISSN

protected String ISSN

String containing the record's ISSN (using for Holdings retrieval)

from

protected String from

String containing the record's from field (using for Holdings retrieval)

bufSize

protected static final int bufSize

String containing the default StringBuffer size

authorFields

protected static final String authorFields

String containing the BER field tags for authors (100, 700)

authorIndexTag

protected static final String authorIndexTag

String containing the author index tag

authorHotlinkTag

protected static final String authorHotlinkTag

String containing the tag for the author field to be hotlinked (100/1)

authorHotlinkAllTag

protected static final String authorHotlinkAllTag

String containing the tags for the author fields to be hotlinked (100/1, 700/1)

authorAllSubFields

protected static final String authorAllSubFields

String containing a list of subfields to be used for authors when no hot link is generated

authorNotHotSubFields

protected static final String authorNotHotSubFields

String containing a list of subfields to be used for non-hotlinked portion of the author display

authorSeparator

protected static final String authorSeparator

String containing the separator for authors

authorTerminator

protected static final String authorTerminator

String containing the terminator for authors

orgFields

protected static final String orgFields

String containing the tags for organizations (110/410)

orgTag1

protected static final String orgTag1

String containing the tag for the first organization (110/1,2)

orgTag2

protected static final String orgTag2

String containing the tag for the second organization (410/1,2)

meetingFields

protected static final String meetingFields

String containing the tags for meetings (411, 811)

meetingTag1

protected static final String meetingTag1

String containing the tag for the first meeting field (411/1)

meetingTag2

protected static final String meetingTag2

String containing the tag for the second meeting field (811/1)

fromISSNTag

protected static final String fromISSNTag

String containing the ISSN tag within the from field (773/24)

fromSubFields1

protected static final String fromSubFields1

String containing the subfields that follow the first from tag (773)

fromSubFields2

protected static final String fromSubFields2

String containing the subfields that follow the second from tag (510)

fromField1

protected static final String fromField1

String containing the first from field tag (773)

fromField2

protected static final String fromField2

String containing the second from field tag (510)

fromFields

protected static final String fromFields

String containing both from field tags (773, 510)

includeField

protected static final String includeField

String containing the include field tag (505)

includeSubFields

protected static final String includeSubFields

String containing the include subfields (*)

includeFieldTerminator

protected static final String includeFieldTerminator

String containing the include terminator

includeSubFieldTerminator

protected static final String includeSubFieldTerminator

String containing include subfield terminator

subjectFields

protected static final String subjectFields

String containing the subject tags (650, 651, 600, 610, 690)

subjectField600

protected static final int subjectField600

Integer containing the fldid for subject field 600

subjectField610

protected static final int subjectField610

Integer containing the fldid for subject field 610

subjectField650

protected static final int subjectField650

Integer containing the fldid for subject field 650

subjectField651

protected static final int subjectField651

Integer containing the fldid for subject field 651

subjectField690

protected static final int subjectField690

Integer containing the fldid for subject field 690

subjectIndexTag

protected static final String subjectIndexTag

String containing the subject index tag

subjectSubFieldTerminator

protected static final String subjectSubFieldTerminator

String containing the subject field terminator

noteField

protected static final String noteField

String containing the note field tag (500)

noteSubFields

protected static final String noteSubFields

String containing the note subfields tag (*)

publisherTag

protected static final String publisherTag

String containing the publisher tag (260/2)

yearTag

protected static final String yearTag

String containing the year tag (260/3)

databaseNoTag

protected static final String databaseNoTag

String containing the databaseNo tag (069/1)

documentTypeTag

protected static final String documentTypeTag

String containing the documentType tag (073/1)

recordTypeTag

protected static final String recordTypeTag

String containing the recordType (945/1)

govDocNoTag

protected static final String govDocNoTag

String containing the govDocNo tag (074/1)

CODENTag

protected static final String CODENTag

String containing CODEN tag (030/1)

languageTag

protected static final String languageTag

String containing language tag (546/1)

countryTag

protected static final String countryTag

String containing country tag (260/1)

abstractTag

protected static final String abstractTag

String containing abstract tag (520/1)

ISSNTag

protected static final String ISSNTag

String containing ISSN tag (022/1)

ISBNTag

protected static final String ISBNTag

String containing ISBN tag (020/1)

Constructor Detail

MarcArticleFmt

public MarcArticleFmt()

Constructs a MarcArticleFmt object.

Method Detail

addTitleBookMark

protected final void addTitleBookMark(DataDir dir,
                                      int whichRecord,
                                      String fields,
                                      String fields2,
                                      String label)

Adds a title with bookmark widgit

Parameters:

dir - a DataDir that contains the record to be formatted

recno - an integer that contains the current record number for display of the the title.

fields - the primary set of BER tags to use as the title

fields2 - the secondary set of BER tags to use as the title

Returns:

void

addAuthor

protected final void addAuthor(DataDir dir,
                               boolean useLabel,
                               boolean useTrailer,
                               boolean createHotLink)

Formats the authors and add them to the HTML

Specifications for the author fields:

100/1,17,4,2,3,5,6

700/1,17,4,2,3,5,6

Make 100/1 a hotlink with au: as the indextag

Use period "." as a terminator

Use period space space ". " as a separator

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

useTrailer - a boolean that specifies whether or not a trailer is needed

createHotLink - a boolean that specifies whether or not a hotlink is created

Returns:

void

addOrganization

protected final void addOrganization(DataDir dir,
                                     boolean useLabel)

Formats the organizations and adds them to the HTML

Specifications for the organization fields:

110/1-2

410/1-2

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addMeeting

protected final void addMeeting(DataDir dir,
                                boolean useLabel)

Formats the meetings and adds them to the HTML

Specifications for the meeting fields:

411/1

811/1

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addFrom

protected final void addFrom(DataDir dir,
                             boolean useLabel)

Formats the from fields and adds them to the HTML

Specifications for the from fields:

773/20,19,1,7,4,24

510,1,2,30

When displaying the 773 fields, add " ISSN: " before subfield 24

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addIncludes

protected final void addIncludes(DataDir dir,
                                 boolean useLabel)

Formats the includes and adds them to the HTML

Specifications for the includes field:

505/'*'

Use period space dash dash (". --") to terminate each 505

Use period space space (". ") to terminate each subfield

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addSubjects

protected final void addSubjects(DataDir dir,
                                 boolean useLabel,
                                 boolean createHotLink)

Formats the subjects and adds them to the HTML

Specifications for the ISBN field:

020/1

650/1,2,24,25,26

651/1,2,24,25,26

600/1,2,3,8,14,15,24,25,26

610/1,2,24,25,26

690/1

Make all subfields hot individually

Use sh: as the hotlink index

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

createHotLink - a boolean that specifies whether or not a hot link is created

Returns:

void

addNotes

protected final void addNotes(DataDir dir)

Formats the notes and adds them to the HTML

Specifications for the notes field:

500/'*'

Output in data order

Characters before a ':' become the label

Characters after a ':' become the data in the field

Fields go on a new line

Parameters:

dir - a DataDir that contains the record to be formatted

Returns:

void

addPublisher

protected final void addPublisher(DataDir dir,
                                  boolean useLabel)

Formats the publisher and adds it to the HTML

Specifications for the publisher field:

260/2

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addYear

protected final void addYear(DataDir dir,
                             boolean useLabel,
                             boolean useTrailer)

Formats the year field and adds it to the HTML

Specifications for the year field:

260/3

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

useTrailer - a boolean that specifies whether or not a trailer is needed

Returns:

void

addAbstract

protected final void addAbstract(DataDir dir,
                                 boolean useLabel)

Formats the abstract and adds it to the HTML

Specifications for the abstract field:

520/1

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addCountry

protected final void addCountry(DataDir dir,
                                boolean useLabel)

Formats the country and adds it to the HTML

Specifications for the language field:

260/1

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addLanguage

protected final void addLanguage(DataDir dir,
                                 boolean useLabel)

Formats the language and adds it to the HTML

Specifications for the language field:

546/1

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addISBN

protected final void addISBN(DataDir dir,
                             boolean useLabel,
                             boolean useTrailer)

Formats the ISBN and adds it to the HTML

Specifications for the ISBN field:

020/1

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

useTrailer - a boolean that specifies whether or not a trailer is needed

Returns:

void

addISSN

protected final void addISSN(DataDir dir,
                             boolean useLabel,
                             boolean useTrailer,
                             boolean createHoldingsLink,
                             int whichRecord)

Formats the ISSN and adds it to the HTML

Specifications for the ISSN field:

022/1

Generate a link to the holdings using the author, title, and from information.

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

useTrailer - a boolean that specifies whether or not a trailer is needed

createHoldingsLink - a boolean that specifies whether or not a holdings link should be created

whichRecord - an integer to indicate which record to return to if the holdings link is used

Returns:

void

addCODEN

protected final void addCODEN(DataDir dir,
                              boolean useLabel)

Formats the CODEN and adds it to the HTML

Specifications for the CODEN field:

030/1

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addGovDocNo

protected final void addGovDocNo(DataDir dir,
                                 boolean useLabel)

Formats the government document number and adds it to the HTML

Specifications for the government document number field:

074/1

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addRecordType

protected final void addRecordType(DataDir dir,
                                   boolean useLabel)

Formats the record type and adds it to the HTML

Specifications for the record type field:

945/1

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addDocumentType

protected final void addDocumentType(DataDir dir,
                                     boolean useLabel)

Formats the document type and adds it to the HTML

Specifications for the document type field:

073/1

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addDatabaseNo

protected final void addDatabaseNo(DataDir dir,
                                   boolean useLabel)

Formats the database number field and adds it to the HTML

Specifications for the database number field:

069/1

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

Returns:

void

addLibraries

protected final void addLibraries(DataDir dir,
                                  boolean useLabel,
                                  boolean useHTML)

Formats the libraries field and adds it to the string being built

Specifications for the libraries field:

948/8

Parameters:

dir - a DataDir that contains the record to be formatted

useLabel - a boolean that specifies whether or not a label is needed

useHTML - a boolean that specifies whether or not embedded is needed

Returns:

void

labelMaker

protected String labelMaker(String text)

Creates a label from some text

Parameters:

text - a String that contains the text to be made into a label

Returns:

String the text concatenated within the begLabel and endLabel strings