com.raritantechnologies.searchApp.taglibrary
Class NestedResultRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.NestedResultRenderer

All Implemented Interfaces:

IConfigurable, IResultRenderer

public class NestedResultRenderer

extends java.lang.Object

implements IResultRenderer

Renders a set of nested results using a delegate IDisplayFormRenderer.

XML Configuration Template:

   <ResultRenderer class="com.raritantechnologies.searchApp.taglibrary.NestedResultRenderer"
                      nestedResultField="[ name of nested Result field to obtain nested IResultSet ]"
                      displayFormName="[ optional name of Display Form (if using System DisplayForm) ]"
                      noResultsMessage="[ optional return value if there are no nested results ]" >

     <DisplayFormRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.IDisplayFormRenderer ]" >

     </DisplayFormRenderer>

   </ResultRenderer>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

NestedResultRenderer()

Method Summary

java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
void	getConfigurationXML(java.io.Writer writer)
IResultRenderer	getRenderer(java.lang.String name) Provides for nested result renderers.
void	initialize(org.w3c.dom.Element elem) IResultRenderers are XML configurable.
boolean	isEnabled()
java.lang.String	renderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext) return an HTML fragment using the data contained within the IResult object.
void	setEnable(boolean enabled) provides show/hide control.

Methods inherited from class java.lang.Object

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

Constructor Detail

NestedResultRenderer

public NestedResultRenderer()

Method Detail

initialize

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

Description copied from interface: IResultRenderer

IResultRenderers are XML configurable.

Specified by:

initialize in interface IResultRenderer

renderResult

public java.lang.String renderResult(IResult result,
                                     int firstResult,
                                     int lastResult,
                                     int resultNum,
                                     RaritanPageContext pageContext)

return an HTML fragment using the data contained within the IResult object.

Specified by:

renderResult in interface IResultRenderer

setEnable

public void setEnable(boolean enabled)

provides show/hide control.

Specified by:

setEnable in interface IResultRenderer

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface IResultRenderer

getRenderer

public IResultRenderer getRenderer(java.lang.String name)

Provides for nested result renderers. returns an instance of IResultRenderer or null if result renderer of given name is not found.

Specified by:

getRenderer in interface IResultRenderer

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IResultRenderer

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)

Specified by:

getConfigurationXML in interface IResultRenderer