com.raritantechnologies.searchApp.browse.taglibrary
Class BrowseDisplayForm

java.lang.Object
  BodyTagSupport
      com.raritantechnologies.searchApp.taglibrary.DisplayForm
          com.raritantechnologies.searchApp.browse.taglibrary.BrowseDisplayForm

All Implemented Interfaces:

IConfigurable, ICustomTag

public class BrowseDisplayForm

extends DisplayForm

Builds a BrowseList in memory using an InMemoryBrowse Object.

getBody( ) method creates an interactive browse list on the terms of a result field. XML Configuration Template

   <DisplayForm class="com.raritantechnologies.searchApp.browse.taglibrary.BrowseDisplayForm"
                   resultTermField="[ field in result set that is to be browsed on ]" >

   </DisplayForm>




See Also:
Serialized Form









Field Summary

 
Fields inherited from class com.raritantechnologies.searchApp.taglibrary.DisplayForm
activeDisplayKey, activeDisplayParam, categoryParam, DEFAULT_PAGE_SIZE, formName, ignoreFormTypes, noResultString, pageNum, pageNumParam, pageSize, queryFieldFilters, resultSetKey, searchFormTypes, searchParameters, sourceTypeParam, userQueryParams
 



Constructor Summary
BrowseDisplayForm()



           
 



Method Summary




 java.lang.String
getBody(RaritanPageContext rpc)



          Renders the results display form given a search request encoded within the RaritanPageContext.



 void
initialize(org.w3c.dom.Element elem)



          This initialize method is used when the DisplayForm is contained in a wrapper object such
 as a TabbedCustomTag - and is an alternate way of initiating a DisplayForm from the JSP custom
 tag initialization via the java bean methods.


 
Methods inherited from class com.raritantechnologies.searchApp.taglibrary.DisplayForm
doAfterBody, doStartTag, getBody, getCachedResultSet, getCachedResultSet, getDisplayFormRenderer, getDisplayFormRenderer, getDisplayRenderer, getFormName, getInstance, getNewResultSet, getPageNum, getPageNum, getPageNum, getPageNum, getpageSize, getPageSize, getPageSize, getResults, getResults, getResults, getResults, getResultSetKey, getResultSetKey, getResultSetKey, getResultSetKey, getSearchFormName, getSessionData, getSourceCategory, getSourceType, ignoreFormType, initialize, setActiveDisplayKey, setActiveDisplayParam, setCachedResultSet, setCachedResultsName, setCategoryParam, setFormName, setIgnoreFormTypes, setNoResultsMessage, setPageNumParam, setPageSize, setResultSetKey, setResultSetKey, setSearchFormName, setSearchFormTypes, setSearchParameters, setSourceTypeParam, setUseCache, setUserQueryParameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 








Constructor Detail



BrowseDisplayForm
public BrowseDisplayForm()






Method Detail



getBody
public java.lang.String getBody(RaritanPageContext rpc)

Description copied from class: DisplayForm
Renders the results display form given a search request encoded within the RaritanPageContext.

 Key input parameters:
 

   
formType - determines whether the input is a "search" command or other (paging etc.) 
   
pageSize - determines the current page size for the displayed result set.
   
sourceType - determines (together with category) the type of source map that will be searched.
   
category   - determines (together with sourceType) the source that will be searched.
 


Specified by:
getBody in interface ICustomTag
Overrides:
getBody in class DisplayForm








initialize
public void initialize(org.w3c.dom.Element elem)

Description copied from class: DisplayForm
This initialize method is used when the DisplayForm is contained in a wrapper object such
 as a TabbedCustomTag - and is an alternate way of initiating a DisplayForm from the JSP custom
 tag initialization via the java bean methods.

 Note that the main configuration Display form Renderer initialization is handled
 separately - i.e. this is NOT the initialization for the DisplayForm tags in the main configuration XML.
 Those tags configure the IDisplayFormRenderer used by this DisplayForm object.


Specified by:
initialize in interface IConfigurable
Overrides:
initialize in class DisplayForm