com.raritantechnologies.searchApp.taglibrary
Interface IDisplayFormRenderer

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

AtomDisplayFormRenderer, BasicDisplayFormRenderer, BibliographicDisplayFormRenderer, CompositeDisplayFormRenderer, CompositeHeaderRenderer, DidYouMeanDisplayFormRenderer, DisplayControlTag, DivDisplayFormRenderer, DropdownDisplayFormRenderer, DynamicDisplayFormRenderer, EndecaDimensionDisplayFormRenderer, FastTaxonomyRenderer, FilteringDisplayFormRenderer, HighlightingDisplayFormRenderer, JSONDisplayFormRenderer, NumberResultsRenderer, PageImportDisplayFormRenderer, PanelDisplayFormRenderer, RSSDisplayFormRenderer, SearchSourcePropertyRenderer, SessionDataDisplayFormRenderer, SpacerRenderer, SystemObjectDisplayFormRenderer, TabbedDisplayFormRenderer, TableDisplayFormRenderer, TemplateDisplayFormRenderer, XMLDisplayFormRenderer

public interface IDisplayFormRenderer

extends IConfigurable

Interface for Display page renderers. DisplayForm renderers are responsible for generating HTML displays of information contained in search result sets, represented by a IResultSet object.

DisplayForm renderers are initialized through the application Configuration as follows. For XML configurations, the XMLConfigurationManager and XMLSearchFieldMapFactory initialize all <DisplayForm> tags within the configuration XML. If the <DisplayForm> tag has a "rendererClass" attribute (which must be an implementation class of IDisplayFormRenderer), the IDisplayFormRenderer is constructed and its initialize( Element ) method is called with the contents of the <DisplayForm> tag whose general format is shown below:

  <DisplayForm 
      name="[display form name]" 
      rendererClass="[implementation class of IDisplayFormRenderer]" >

    <!-- parameters required by DisplayFormRenderer Class -->

  </DisplayForm>
 

Once initialized by the RTI Framework, the a DisplayFormRenderer can be acquired by name from the ConfigurationManager using the following code sequence:

    ConfigurationManager cMan = ConfigurationManager.getInstance( );
    ISearchFieldMap sfMap = cMan.getSearchFieldMap( );

    IDisplayFormRenderer dfRenderer = sfMap.getDisplayFormRenderer( "The Display Form Name" );
  

The following UML class diagram shows the main Display Form Renderer classes:

Developed by Raritan Technologies .

Author:

Ted Sullivan

See Also:

XMLConfigurationManager, XMLSearchFieldMapFactory

Field Summary

static java.lang.String

TEMPLATE

Method Summary

void	addBodyTrailerContent(java.lang.String content) Add html content to be appended to the body of the displayFormRenderer
void	disableRenderers(java.util.HashSet disabledRenderers)
void	enableRenderers(java.util.HashSet enabledRenderers)
java.lang.String	getBody(IResultSet resultSet, java.lang.String displayFormName, RaritanPageContext pageContext) Returns the display form body as an HTML fragment, by formatting the data contained in an IResultSet.
IResultRenderer	getResultRenderer(java.lang.String name)
void	initialize(org.w3c.dom.Element elem) Initialize the search form renderer from the configuration XML.
void	setDisabledRendererParam(java.lang.String disabledParam)
void	setEnabledRendererParam(java.lang.String enabledParam)
void	setEnabledRenderers(java.lang.String displayForm, RaritanPageContext pageContext)

Field Detail

TEMPLATE

public static final java.lang.String TEMPLATE

See Also:

Constant Field Values

Method Detail

initialize

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

Initialize the search form renderer from the configuration XML.

Specified by:

initialize in interface IConfigurable

getBody

public java.lang.String getBody(IResultSet resultSet,
                                java.lang.String displayFormName,
                                RaritanPageContext pageContext)

Returns the display form body as an HTML fragment, by formatting the data contained in an IResultSet.

addBodyTrailerContent

public void addBodyTrailerContent(java.lang.String content)

Add html content to be appended to the body of the displayFormRenderer

getResultRenderer

public IResultRenderer getResultRenderer(java.lang.String name)

setEnabledRendererParam

public void setEnabledRendererParam(java.lang.String enabledParam)

setDisabledRendererParam

public void setDisabledRendererParam(java.lang.String disabledParam)

setEnabledRenderers

public void setEnabledRenderers(java.lang.String displayForm,
                                RaritanPageContext pageContext)

enableRenderers

public void enableRenderers(java.util.HashSet enabledRenderers)

disableRenderers

public void disableRenderers(java.util.HashSet disabledRenderers)