com.raritantechnologies.verity.parametric.taglibrary
Class ParametricDisplayForm

java.lang.Object
  BodyTagSupport
      com.raritantechnologies.searchApp.taglibrary.DisplayForm
          com.raritantechnologies.verity.parametric.taglibrary.ParametricDisplayForm

All Implemented Interfaces:

IConfigurable, ICustomTag

public class ParametricDisplayForm

extends DisplayForm

Subclass of com.raritantechnologies.searchApp.taglibrary.DisplayForm customized for Parametric search applications.

Developed by Raritan Technologies .

Author:

Ted Sullivan

See Also:

Serialized Form

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.taglibrary.DisplayForm

activeDisplayKey, activeDisplayParam, categoryParam, DEFAULT_PAGE_SIZE, formName, ignoreFormTypes, noResultString, pageNumParam, queryFieldFilters, resultSetKey, searchFormTypes, searchParameters, sourceTypeParam, userQueryParams

Constructor Summary

ParametricDisplayForm()

Method Summary

int	doAfterBody()
int	doStartTag()
java.lang.String	getBody(RaritanPageContext rPageContext) Renders the results display form given a search request encoded within the RaritanPageContext.
java.lang.String	getFormName()
int	getPageNum()
java.lang.String	getpageSize()
IResultSet	getResults(int pageNum, int pageSize, RaritanPageContext pageContext) Get the current results.
void	setFormName(java.lang.String formName) formType is the type specified in the tag of the configuration XML
void	setPageSize(java.lang.String pageSize)
void	setParaBeanName(java.lang.String paraBeanName)

Methods inherited from class com.raritantechnologies.searchApp.taglibrary.DisplayForm

getBody, getCachedResultSet, getCachedResultSet, getDisplayFormRenderer, getDisplayFormRenderer, getDisplayRenderer, getInstance, getNewResultSet, getPageNum, getPageNum, getPageNum, getPageSize, getPageSize, getResults, getResults, getResults, getResultSetKey, getResultSetKey, getResultSetKey, getResultSetKey, getSearchFormName, getSessionData, getSourceCategory, getSourceType, ignoreFormType, initialize, initialize, setActiveDisplayKey, setActiveDisplayParam, setCachedResultSet, setCachedResultsName, setCategoryParam, setIgnoreFormTypes, setNoResultsMessage, setPageNumParam, 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

ParametricDisplayForm

public ParametricDisplayForm()

Method Detail

setFormName

public void setFormName(java.lang.String formName)

formType is the type specified in the tag of the configuration XML

Overrides:

setFormName in class DisplayForm

getFormName

public java.lang.String getFormName()

Overrides:

getFormName in class DisplayForm

getpageSize

public java.lang.String getpageSize()

Overrides:

getpageSize in class DisplayForm

setPageSize

public void setPageSize(java.lang.String pageSize)

Overrides:

setPageSize in class DisplayForm

getPageNum

public int getPageNum()

Overrides:

getPageNum in class DisplayForm

setParaBeanName

public void setParaBeanName(java.lang.String paraBeanName)

doStartTag

public int doStartTag()
               throws JspException

Overrides:

doStartTag in class DisplayForm

Throws:

JspException

getBody

public java.lang.String getBody(RaritanPageContext rPageContext)

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

getResults

public IResultSet getResults(int pageNum,
                             int pageSize,
                             RaritanPageContext pageContext)

Description copied from class: DisplayForm

Get the current results. Returns cached results for this page if the result set has already been calculated by a previous tag. If not, the search is executed.

Overrides:

getResults in class DisplayForm

doAfterBody

public int doAfterBody()
                throws JspException

Overrides:

doAfterBody in class DisplayForm

Throws:

JspException