ORG.oclc.gadgets
Class TermListDisplay

java.lang.Object
  |
  +--ORG.oclc.gadgets.FormatRecords
        |
        +--ORG.oclc.gadgets.TermListDisplay

public class TermListDisplay

extends FormatRecords

The TermListDisplay class is a gadget that creates the HTML string used to display the results of a related term search in either a thesaurus that supports a database or in the database itself. It uses the parameters contained in a RequestManager object and the parameters for the gadget read from the configuration files to build the appropriate output. If an error occurs, an empty string("") is returned.

The parameters to the gadget are:
fmt - the rule-based formatting class to use
dataWrapper - a pointer to the html that will be used for the display
tempdb - a flag indicating which set of UserState variables to use

This class uses the RTLTerms hashtable from the UserState to build the display. Each entry in the hashtable is a datapairs object that contains the term, a checkbox name and whether or not there is a hot link to a Thesaurus term.

See Also:

UserStateObject, WebZFormatter, FormatRecords

Field Summary

protected String

termdbname The name of the database that the terms come from

Fields inherited from class ORG.oclc.gadgets.FormatRecords

dataWrappers, dbname, displayGadget, errormsg, fmtName, gadgetInfo, initted, numHoldings, recno, recordData, recordformat, resultset, returnedRecs, searchKeyFmt, user, zDb, zUserData

Constructor Summary

TermListDisplay()
Constructs a TermListDisplay object.

Method Summary

String	buildit(RequestManager rMngr, String name) Generates a String containing the HTML for the Related Term list display.
protected void	setInfo(DataPairs dataObj) This method pulls the values out of a DataPairs
String	toString() Generates a String representation of the object.

Methods inherited from class ORG.oclc.gadgets.FormatRecords

formatPresentData, getDataWrappers, init, runFormat, runFormat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

termdbname

protected String termdbname

The name of the database that the terms come from

Constructor Detail

TermListDisplay

public TermListDisplay()

Constructs a TermListDisplay object.

Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)

Generates a String containing the HTML for the Related Term list display. The raw records are processed by the AddToMap rule which builds the RTLTerms hashtable. Each term in the hashtable has a datapairs object associated with it. Variables are set via setinfo which pulls the values from the datapairs.

Parameters:

rMngr - object containing input parameters for the request.

name - the name of the gadget - the section name in the configuration file defining the particular gadget.

Returns:

String

Overrides:

buildit in class FormatRecords

setInfo

protected void setInfo(DataPairs dataObj)

This method pulls the values out of a DataPairs

toString

public String toString()

Generates a String representation of the object.

Returns:

String

Overrides:

toString in class FormatRecords