com.raritantechnologies.quickstart.taglibrary
Class AppendingResultRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      com.raritantechnologies.quickstart.taglibrary.AppendingResultRenderer

All Implemented Interfaces:

IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class AppendingResultRenderer

extends BasicResultRenderer

implements IResultRenderer

Appends the results of a number of IResultRenderers. Useful for combining multiple fields into a single html table cell, or to generate a spreadsheet view of a result set.

For unadorned field values use a SimpleFieldRenderer.

XML Configuration Template:

   <ResultRenderer 
      rendererClass="com.raritantechnologies.quickstart.taglibrary.AppendingResultRenderer"
      separator="[ field separator ]"
      charLimit="[maximum number of characters in complete rendered result - defaults to no limit]" >

     <!-- nested result renderers whose outputs will be concatenated -->
     <ResultRenderer 
         rendererClass="[some com.raritantechnologies.quickstart.taglibrary.com.raritantechnologies.quickstart.taglibrary.IResultRenderer class]" >
     </ResultRenderer>

     <ResultRenderer 
         rendererClass="[some com.raritantechnologies.quickstart.taglibrary.com.raritantechnologies.quickstart.taglibrary.IResultRenderer class]" >
     </ResultRenderer>

     <!-- etc ... -->

   </ResultRenderer>
 

Developed by Raritan Technologies Inc..

Author:

Glenn Robitaille

Field Summary

protected java.util.Vector

rendererList

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

enabled, name, prefBeanName, prefCompareValue, prefEnableIfInChecklist, prefEnableIfInYesno

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

TEMPLATE

Constructor Summary

AppendingResultRenderer()

Method Summary

protected java.lang.String	doRenderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext)
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
void	getConfigurationXML(java.io.Writer writer)
IResultRenderer[]	getFieldArray()
int	getMaxChars()
java.lang.String	getSeparator()
void	initialize(org.w3c.dom.Element elem) IResultRenderers are XML configurable.
void	setFieldArray(IResultRenderer[] fieldList)
void	setMaxChars(int maxChars)
void	setSeparator(java.lang.String separator)

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

getPrefBeanName, getPrefCompareValue, getPrefEnableIfInChecklist, getPrefEnableIfInYesno, getRenderer, isEnabled, renderResult, setEnable

Methods inherited from class java.lang.Object

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

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

getRenderer, isEnabled, renderResult, setEnable

Field Detail

rendererList

protected java.util.Vector rendererList

Constructor Detail

AppendingResultRenderer

public AppendingResultRenderer()

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

Overrides:

initialize in class BasicResultRenderer

doRenderResult

protected java.lang.String doRenderResult(IResult result,
                                          int firstResult,
                                          int lastResult,
                                          int resultNum,
                                          RaritanPageContext pageContext)

Specified by:

doRenderResult in class BasicResultRenderer

setSeparator

public void setSeparator(java.lang.String separator)

getSeparator

public java.lang.String getSeparator()

setMaxChars

public void setMaxChars(int maxChars)

getMaxChars

public int getMaxChars()

setFieldArray

public void setFieldArray(IResultRenderer[] fieldList)

getFieldArray

public IResultRenderer[] getFieldArray()

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