com.raritantechnologies.quickstart.taglibrary
Class FieldRangeImageRenderer

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

All Implemented Interfaces:

IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class FieldRangeImageRenderer

extends BasicResultRenderer

implements IResultRenderer

Result field renderer that renders an image depending on the numerical value of a result field. Useful for rendering a graphic display of relevance user ranking.

XML Configuration Template:

   <ResultRenderer 
       rendererClass="com.raritantechnologies.quickstart.taglibrary.FieldRangeImageRenderer"
       fieldID="[ field to get numerical value (e.g. score or relevance) ]"
       rangeFormula="[ arithmetic formula to normalize to configured ranges - {VALUE} used as placeholder for result value ]" >

     <!-- two or more Range tags -->
     <Range minValue="[ floating point value that value >= than ]"
               maxValue="[ floating point value that value < than ]"
               imageURL="[ image to use if value falls in this range ]" />
     <Range etc... >

   </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

FieldRangeImageRenderer()

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)
void	initialize(org.w3c.dom.Element elem) IResultRenderers are XML configurable.

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

Constructor Detail

FieldRangeImageRenderer

public FieldRangeImageRenderer()

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

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