ORG.oclc.gadgets
Class DbListforScanResult

java.lang.Object
  |
  +--ORG.oclc.gadgets.DbListforScanResult

public class DbListforScanResult

extends Object

implements GadgetBuilder

The DbListforScanResult class is a gadget that creates the HTML string for the display of topics and individual database results from a search. 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:
labelFont - the HTML font to use for display of the header that precedes the database names.
dbnameFont - the HTML font to use for display of the database names.

See Also:

UserStateObject, RequestManager, DataPairs, StyleTable, TopicEntry, Topics, ZDb, ZUserData, DbResults, FormatBerUtil

Constructor Summary

DbListforScanResult()
Constructs a DbListforScanResult object.

Method Summary

protected void	buildIndividualDbList(String dbname) Build the SCAN results breakdown for a single database.
String	buildit(RequestManager rMngr, String name) Generates a String containing the HTML for the Topic & Database names with associated postings from a scan request using the parameters contained in the RequestManager object and the name of the gadget.
protected void	buildTopicDbList(String dbname, String topicName) Build the SCAN results breakdown for a TopicEntry by database.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbListforScanResult

public DbListforScanResult()

Constructs a DbListforScanResult object.

Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)

Generates a String containing the HTML for the Topic & Database names with associated postings from a scan request using the parameters contained 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

buildTopicDbList

protected void buildTopicDbList(String dbname,
                                String topicName)

Build the SCAN results breakdown for a TopicEntry by database.

Parameters:

topicName - The name of the TopicEntry that SCAN was issued.

Returns:

String The list of DB results as an HTML table for the SCAN.

buildIndividualDbList

protected void buildIndividualDbList(String dbname)

Build the SCAN results breakdown for a single database.

Returns:

String A single DB results as an HTML table for the SCAN.