com.raritantechnologies.endeca.taglibrary
Class EndecaDimensionDisplayFormRenderer

java.lang.Object
  com.raritantechnologies.endeca.taglibrary.EndecaDimensionDisplayFormRenderer

All Implemented Interfaces:

IConfigurable, IDisplayFormRenderer

public class EndecaDimensionDisplayFormRenderer

extends java.lang.Object

implements IDisplayFormRenderer

Composite IDisplayFormRenderer that renders an Endeca Dimension Search Result.

XML Configuration Template:

   <DisplayForm class="com.raritantechnologies.endeca.taglibrary.EndecaDimensionDisplayFormRenderer" 
                   nameField="[ name of field that gets the Endeca Dimension name (default='name') ]"
                   pathField="[ name of field that gets the Dimension path (default='path') ]"
                   dimIDField="[ name of field that gets the Endeca Dimension ID (default='DimensionID') ]"
                   endecaDimension="[ name of the Endeca Dimension field to render ]"
                   treeTitle="[ (optional) title to render the tree ]"
                   noTreeDisplay="[ (optional) string to display if there is no tree to render ]" >

     <!-- An RTI DisplayFormRenderer used to render the Dimension results as a list -->
     <DisplayFormRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.IDisplayFormRenderer ]" >

     </DisplayFormRenderer>

     <!-- Alternately, can render the Dimension Results as a Tree: -->
     <TreeRenderer class="[ class of com.raritantechnologies.utils.tree.taglibrary.ITreeRenderer ]"
                      treeURL="[ URL for tree hyperlinks ]" >

     </TreeRenderer>

   </DisplayForm>
 

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.taglibrary.IDisplayFormRenderer

TEMPLATE

Constructor Summary

EndecaDimensionDisplayFormRenderer()

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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EndecaDimensionDisplayFormRenderer

public EndecaDimensionDisplayFormRenderer()

Method Detail

initialize

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

Description copied from interface: IDisplayFormRenderer

Initialize the search form renderer from the configuration XML.

Specified by:

initialize in interface IDisplayFormRenderer

getBody

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

Description copied from interface: IDisplayFormRenderer

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

Specified by:

getBody in interface IDisplayFormRenderer

addBodyTrailerContent

public void addBodyTrailerContent(java.lang.String content)

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

Specified by:

addBodyTrailerContent in interface IDisplayFormRenderer

getResultRenderer

public IResultRenderer getResultRenderer(java.lang.String name)

Specified by:

getResultRenderer in interface IDisplayFormRenderer

setEnabledRendererParam

public void setEnabledRendererParam(java.lang.String enabledParam)

Specified by:

setEnabledRendererParam in interface IDisplayFormRenderer

setDisabledRendererParam

public void setDisabledRendererParam(java.lang.String disabledParam)

Specified by:

setDisabledRendererParam in interface IDisplayFormRenderer

setEnabledRenderers

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

Specified by:

setEnabledRenderers in interface IDisplayFormRenderer

enableRenderers

public void enableRenderers(java.util.HashSet enabledRenderers)

Specified by:

enableRenderers in interface IDisplayFormRenderer

disableRenderers

public void disableRenderers(java.util.HashSet disabledRenderers)

Specified by:

disableRenderers in interface IDisplayFormRenderer