Open SiteSearch 4.1.1
Final

ORG.oclc.gadgets
Class IndexSelect

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

public class IndexSelect
extends Object
implements GadgetBuilder

The IndexSelect class is a gadget that builds an HTML select list of indices for a 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:
setSelected = true/false
type = scan/query to indicate whether the selected index is from the entity scanindex or index
indexlist = the name of the list in the [IndexList] section of the database configuration file to use to build the list.
widgetName = the text appended to 'index' for the widget
selectsize = the size parameter for the selectList

For efficiency purposes, the index select string is generated one time for each database/gadgetName and saved in the gadget Hashtable object. Each subsequent request for the data is a table lookup to locate the appropriate string.


Constructor Summary
IndexSelect()
          Constructs an IndexSelect object.
 
Method Summary
 String buildit(RequestManager rMngr, String name)
          Generates a String containing the HTML for the index select list for the currently selected database 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

IndexSelect

public IndexSelect()
Constructs an IndexSelect object.
Method Detail

buildit

public String buildit(RequestManager rMngr,
                      String name)
Generates a String containing the HTML for the index select list for the currently selected database 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

Open SiteSearch 4.1.1
Final