ORG.oclc.fmts.obi
Class ArchivefullFmt

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

Direct Known Subclasses:

ArchivebookMarkfullFmt, ArchivemultiFullFmt

public class ArchivefullFmt

extends WebZFormatter

The ArchivefullFmt class formats records from the ISP databases following the ARCHIVE database schema for display in the WebZ interface. The record will be displayed in a full format.

ArchivefullFmt uses the userObject and a Vector of records to return a formatted String that contains the HTML to display. This class is an extension 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 ArchivefullFmt results in HTML that can be displayed in the WebZ interface. Unsuccessful execution will result in a null String being returned.

Field Summary

protected String	begLabel String containing the characters to be used before the label text - usually HTML
protected String	endLabel String containing the characters to be used after the label text - usually HTML
protected String	font String containing the information for specifying a font in HTML
protected String	linkData String containing information for a hotlink
protected String	pathToImages String containing the tag for access the TIFF image within the BER record.
protected String	termData String containing the information for terminating a HTML string
protected String	trailer String containing the label to be used at the end of a field

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

ArchivefullFmt()
Create a ArchivefullFmt object

Method Summary

String	doFormat(Object userObject, Vector records) Format multiple records passed in an input Vector
protected void	formatTags(DataDir dir, boolean doHotLinks, boolean doBookMarkLink, boolean doImageLink) Formats the data from specific tags and adds it to the HTML
protected String	label(String text) Creates a label from some text
protected void	subjectOrdered(String separator, DataDir dir, String fields, String subfields) Format a string in data order

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

pathToImages

protected String pathToImages

String containing the tag for access the TIFF image within the BER record.

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

trailer

protected String trailer

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

termData

protected String termData

String containing the information for terminating a HTML string

linkData

protected String linkData

String containing information for a hotlink

font

protected String font

String containing the information for specifying a font in HTML

Constructor Detail

ArchivefullFmt

public ArchivefullFmt()

Create a ArchivefullFmt object

Method Detail

doFormat

public String doFormat(Object userObject,
                       Vector records)

Format multiple records passed in an input Vector

Parameters:

userObject - a user Object. This is userStateObject(WebZ)

records - a vector of record Objects. For use in WebZ, this is a vector of DataDir objects

Returns:

String contains the HTML representation of the records

Overrides:

doFormat in class WebZFormatter

subjectOrdered

protected final void subjectOrdered(String separator,
                                    DataDir dir,
                                    String fields,
                                    String subfields)

Format a string in data order

Parameters:

separator - a String to use between individual data fields

dir - a DataDir containing the BER data

fields - a String containing the tags for the fields to be processed

subfields - a String containing the tags for the subfields within the fields to be processed

Returns:

label

protected String label(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

formatTags

protected void formatTags(DataDir dir,
                          boolean doHotLinks,
                          boolean doBookMarkLink,
                          boolean doImageLink)

Formats the data from specific tags and adds it to the HTML

Parameters:

dir - a DataDir that contains the record to be formatted

doHotLinks - a boolean that specifies whether or not to generate a hotlink

doBookMarkLink - a boolean that specifies whether or not to generate a link to a bookmark

doImageLink - a boolean that specifies whether or not to generate a link to an image

Returns:

void