com.raritantechnologies.searchApp.sourceMap.taglibrary
Class SourceMapDisplayForm

java.lang.Object
  BodyTagSupport
      com.raritantechnologies.searchApp.taglibrary.DisplayForm
          com.raritantechnologies.searchApp.sourceMap.taglibrary.SourceMapDisplayForm

All Implemented Interfaces:

IConfigurable, ICustomTag

public class SourceMapDisplayForm

extends DisplayForm

Extension of DisplayForm that implements a source-mapped search. Typically used with a com.raritantechnologies.searchApp.sourceMap.SoureMapTree display such as BasicSourceMapTreeRenderer or ExplorerSourceMapTreeRenderer that enables a user to browse to a subject node that is coupled to a set of search sources via an ISourceMap. Implements getResults method by performing a source mapped search (which may be a federated search if there is more than one selected source in the source map).

XML Configuration Template:

  <DisplayForm name="brief" 
      rendererClass="com.raritantechnologies.searchApp.taglibrary.SourceMapDisplayForm" >

     <!-- ResultRenderers etc. as in standard DisplayForm configuration -->

  </DisplayForm>
 

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, pageNum, pageNumParam, pageSize, queryFieldFilters, resultSetKey, searchFormTypes, searchParameters, sourceTypeParam, userQueryParams

Constructor Summary

SourceMapDisplayForm()

SourceMapDisplayForm(java.lang.String sourceMapName, java.lang.String sourceMapTreeName)

Method Summary

IResultSet	getResults(int pageNum, int pageSize, RaritanPageContext pageContext) returns the HTML fragment for the given set of results.
IResultSet	getResults(int pageNum, int pageSize, RaritanPageContext pageContext, java.lang.String sourceType)
IResultSet	getResults(int pageNum, int pageSize, RaritanPageContext pageContext, java.lang.String sourceType, java.lang.String formType)
void	setFormName(java.lang.String formName) formName is the name specified in the <DisplayForm> tag of the configuration XML
void	setSourceMapName(java.lang.String sourceMapName)
void	setSourceMapTreeName(java.lang.String sourceMapTreeName)
void	setUseCachedResult(boolean useCachedResult)

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

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

SourceMapDisplayForm

public SourceMapDisplayForm()

SourceMapDisplayForm

public SourceMapDisplayForm(java.lang.String sourceMapName,
                            java.lang.String sourceMapTreeName)

Method Detail

setFormName

public void setFormName(java.lang.String formName)

Description copied from class: DisplayForm

formName is the name specified in the <DisplayForm> tag of the configuration XML

Overrides:

setFormName in class DisplayForm

setSourceMapName

public void setSourceMapName(java.lang.String sourceMapName)

setSourceMapTreeName

public void setSourceMapTreeName(java.lang.String sourceMapTreeName)

setUseCachedResult

public void setUseCachedResult(boolean useCachedResult)

getResults

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

returns the HTML fragment for the given set of results.

Overrides:

getResults in class DisplayForm

getResults

public IResultSet getResults(int pageNum,
                             int pageSize,
                             RaritanPageContext pageContext,
                             java.lang.String sourceType)

Overrides:

getResults in class DisplayForm

getResults

public IResultSet getResults(int pageNum,
                             int pageSize,
                             RaritanPageContext pageContext,
                             java.lang.String sourceType,
                             java.lang.String formType)

Overrides:

getResults in class DisplayForm