Open SiteSearch 4.1.1
Final

ORG.oclc.gadgets
Class TermFinderHeader

java.lang.Object
  |
  +--ORG.oclc.gadgets.SearchHeader
        |
        +--ORG.oclc.gadgets.TermFinderHeader

public class TermFinderHeader
extends SearchHeader
implements GadgetBuilder

The TermFinderHeader class is a gadget that builds the HTML for the headers on the 'List of Terms' and 'Thesaurus Tree Display' to display the database name and type of results being displayed. It uses the parameters contained in a RequestManager object to build the output. If an error occurs, an empty string("") is returned.

The gadget parameters are:

gadgetLabel: Any text to precede the gadget output

gadgetTrailer: Any text to follow the gadget output

UseThesuarusDb: A true/false value indicating whether the database name should be the thesaurus dbname where the default is false.

typeOfResult: Text that describes the type of result page such as 'List of Terms' or 'Thesaurus Tree Display'.


Fields inherited from class ORG.oclc.gadgets.SearchHeader
style, user
 
Constructor Summary
TermFinderHeader()
          Constructs a TermFinderHeader object.
 
Method Summary
 String buildit(RequestManager rMngr, String name)
          Generates a String containing the HTML for the term list and thesaurus term display headers using the parameters containined in the RequestManager object and the name of the gadget.
 String toString()
          Generates a String representation of the object.
 
Methods inherited from class ORG.oclc.gadgets.SearchHeader
header, relatedTopics
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TermFinderHeader

public TermFinderHeader()
Constructs a TermFinderHeader object.
Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)
Generates a String containing the HTML for the term list and thesaurus term display headers using the parameters containined in the RequestManager object and the name of the gadget.
Specified by:
buildit in interface GadgetBuilder
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 SearchHeader

toString

public String toString()
Generates a String representation of the object.
Specified by:
toString in interface GadgetBuilder
Returns:
String
Overrides:
toString in class SearchHeader

Open SiteSearch 4.1.1
Final