ORG.oclc.gadgets
Class TopicList

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

public class TopicList

extends Object

implements GadgetBuilder

The TopicList class is a gadget that builds an HTML String containing a list of anchors containing topic names that a user has access to. 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:
anchorcommand - the URL command action to put in the anchor.
topicnames - the list of topic names to build anchors for - where the default is all topics.
keepUserDefinedTopics - boolean indicating whether a FILTERED list of topic names should retain any user defined topics and the default is false. This flag is only used when the topicnames parameter specifies a list of topic names to include.

For efficiency purposes, the topic list string is generated for a user only if it does not exist. The formatted string is stored in the user state as the entity named TopicList. Each subsequent request for the data is simply a retrieval from the user state for the saved string.

Constructor Summary

TopicList()
Constructs a TopicList object.

Method Summary

String	buildit(RequestManager rMngr, String name) Generates a String containing the HTML for the topic name anchors 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 java.lang.Object

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

Constructor Detail

TopicList

public TopicList()

Constructs a TopicList object.

Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)

Generates a String containing the HTML for the topic name anchors 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

toString

public String toString()

Generates a String representation of the object.

Specified by:

toString in interface GadgetBuilder

Returns:

String

Overrides:

toString in class Object