com.raritantechnologies.searchApp.taglibrary
Class FormattingResultRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      com.raritantechnologies.searchApp.taglibrary.FormattingResultRenderer

All Implemented Interfaces:

IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class FormattingResultRenderer

extends BasicResultRenderer

IResultRenderer that applies formatting to an IResult field using a IFieldFormatter before rendering it with a nested IResultRenderer.

The formatting operation can occur either before (default) or after the rendering operation and can either be transient (default) or permanent.

XML Configuration Template:

  <ResultRenderer 
     rendererClass="com.raritantechnologies.searchApp.taglibrary.FormattingResultRenderer" 
     name="rendererName"
     formatFirst="true(default)|false"
     formatTransient="true|false(default)" >  <!-- optional - makes formatting permanent for future renderers -->

     <!-- One or more formatting operations to be applied to the result -->
     <Formatter formatterClass="[ class of com.raritantechnologies.searchApp.IFieldFormatter ]" >
        <!-- parameters needed by IFieldFormatter -->
     </Formatter>

     <Formatter etc... >

     <!-- The delegate ResultRenderer that renders the result after the formatting operation(s) is(are) completed -->
     <ResultRenderer rendererClass ="[ class of com.raritantechnologies.searchApp.taglibraryIResultRenderer ]" >
        <!-- parameters needed by the nested renderer -->
     </ResultRenderer>
  </ResultRenderer>
  

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

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

FormattingResultRenderer()

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)
java.util.List	getFieldFormatters()
boolean	getFormatFieldFirst()
boolean	getFormatTransient()
IResultRenderer	getResultRenderer()
void	initialize(org.w3c.dom.Element elem) IResultRenderers are XML configurable.
void	setFieldFormatter(IFieldFormatter fieldFormatter)
void	setFormatFieldFirst(boolean formatFieldFirst)
void	setFormatTransient(boolean formatTransient)
void	setResultRenderer(IResultRenderer resultRenderer)

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

Constructor Detail

FormattingResultRenderer

public FormattingResultRenderer()

Method Detail

doRenderResult

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

Specified by:

doRenderResult in class BasicResultRenderer

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

setFieldFormatter

public void setFieldFormatter(IFieldFormatter fieldFormatter)

getFieldFormatters

public java.util.List getFieldFormatters()

setResultRenderer

public void setResultRenderer(IResultRenderer resultRenderer)

getResultRenderer

public IResultRenderer getResultRenderer()

setFormatTransient

public void setFormatTransient(boolean formatTransient)

getFormatTransient

public boolean getFormatTransient()

setFormatFieldFirst

public void setFormatFieldFirst(boolean formatFieldFirst)

getFormatFieldFirst

public boolean getFormatFieldFirst()

getConfigurationXML

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

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()

getConfigurationXML

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