|
Open SiteSearch 4.1.1 Final |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ORG.oclc.fmts.WebZFormatter
The WebZFormatter class is the parent class for all the WebZ database record formatting classes. It defines variables commonly used by all the formats and provides a common method to initialize them based on the current user state. It also houses commonly used methods to format database records.
RecordFormatter
,
UserStateObject
,
StyleTable
Field Summary | |
protected String |
bookMarkFont
String data type containing the HTML for the font of bookmarked records. |
protected String |
context
String data type containing the user's sessionid. |
protected int |
currecno
integer data type containing the current record number retrieved from the user state. |
protected String |
defaultTextFont
String data type containing the HTML for the default text font. |
protected FormatBerUtil |
fmtUtil
FormatBerUtil object containing formatting record utilities. |
protected int |
fullrecno
integer data type containing the current full record number displayed. |
protected int |
j
integer data type used as a loop counter. |
protected static String |
otherWidgets
String containing other widgets for a Hot-link query. |
protected static String |
queryBad
String containing link to query failure HTML. |
protected static String |
queryNext
String containing link to next query search results HTML. |
protected static String |
queryTarget
String containing link to target HTML |
protected String |
resultset
String data type containing the resultset of the current search. |
protected String |
smallTextFont
String data type containing the HTML for a small text font. |
protected StyleTable |
styles
StyleTable object containing a reference to the user's style. |
protected StringBuffer |
tempRecords
StringBuffer object used as a work buffer for storing formatted data. |
protected int |
toprecno
integer data type containing the current first record number in a multi-record display. |
protected UserStateObject |
user
UserStateObject object containing the user's state. |
Constructor Summary | |
WebZFormatter()
Constructs a WebZFormatter object. |
Method Summary | |
protected void |
addBookMark(int recno)
Appends a record book mark Hot-Link to the FormatBerUtil object formatting buffer using the input record number. |
protected void |
addBookMark(int recno,
String nextPage)
Appends a record book mark Hot-Link to the FormatBerUtil object formatting buffer using the input record number. |
protected void |
addBookMark(int recno,
String nextPage,
String otherInfo)
Appends a record book mark Hot-Link to the FormatBerUtil object formatting buffer using the input record number and an additional string of FETCH information. |
String |
doFormat(Object userObject,
Vector records)
Performs base initialization for the formatting classes and returns a null String if the initialization for the UserStateObject and input Vector object of records fails. |
String |
init(Object userObject,
Vector records)
Sets up a local reference to the UserStateObject for the input userObject and initializes commonly used variables based on the current user state. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
protected UserStateObject user
protected StyleTable styles
protected FormatBerUtil fmtUtil
protected StringBuffer tempRecords
protected String defaultTextFont
protected String smallTextFont
protected String bookMarkFont
protected String resultset
protected String context
protected int j
protected int currecno
protected int toprecno
protected int fullrecno
protected static final String otherWidgets
String containing other widgets for a Hot-link query.
protected static final String queryNext
protected static final String queryBad
String containing link to query failure HTML.
protected static final String queryTarget
String containing link to target HTML
Constructor Detail |
public WebZFormatter()
Method Detail |
public String doFormat(Object userObject, Vector records)
userObject
- the UserStateObject object for the current user.record
- a vector of records to be formatted.public final String init(Object userObject, Vector records)
userObject
- the UserStateObject object for the current user.record
- a vector of records to be formatted.protected final void addBookMark(int recno)
recno
- the record number.protected final void addBookMark(int recno, String nextPage)
recno
- the record number.nextPage
- the name of the next= widget on the bookmark anchorprotected final void addBookMark(int recno, String nextPage, String otherInfo)
recno
- the record number.nextPage
- the name of the next= widget on the bookmark anchorotherInfo
- additional fetch information for the bookmark.
|
Open SiteSearch 4.1.1 Final |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |