ORG.oclc.gadgets
Class ThesTreeDisplay

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

public class ThesTreeDisplay

extends FormatRecords

The ThesTreeDisplay class is a gadget that creates the HTML string used to display the results of a thesaurus exact term search in a thesaurus database. 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
tempdb - a flag indicating which set of UserState variables to use

This class uses the BroadTerms, NarrowTerms, RelatedTerms, MainTerm, and ScopeNote hashtables from the UserState to build the display. These Hashtables are built via AddToMap from the records that are passed into the method. Each entry in the hashtables is a datapairs object that contains the term, a checkbox name whether or not there is a hot link to a Thesaurus term and the number of postings for the thesaurus term in the supported database.

See Also:

UserStateObject, WebZFormatter, FormatRecords, ZDb, TermFinderInfo

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

ThesTreeDisplay()
Constructs a ThesTreeDisplay object.

Method Summary

String	buildit(RequestManager rMngr, String name) Generates a String containing the HTML for the Thesaurus Aided Search (TAS) 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

Constructor Detail

ThesTreeDisplay

public ThesTreeDisplay()

Constructs a ThesTreeDisplay object.

Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)

Generates a String containing the HTML for the Thesaurus Aided Search (TAS) display. The raw records are processed by the AddToMap rule which builds the 5 hashtables: BroadTerms, MainTerm, ReleatedTerms, NarrowTerms, ScopeNote. 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