com.raritantechnologies.recommend.taglibrary
Class RecommendThisResultRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      com.raritantechnologies.recommend.taglibrary.RecommendThisResultRenderer

All Implemented Interfaces:

IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class RecommendThisResultRenderer

extends BasicResultRenderer

implements IResultRenderer

Provides a "Recommend This" link for IResults using an IRecommend Recommendation Engine implementation. Clicking on the link, causes a recommendation request to be sent to the Recommendation Engine. The link is processed by a RecommendServletHandler without redrawing the page.

XML Configuration Template:

   <ResultRenderer class="com.raritantechnologies.recommend.taglibrary.RecommendThisResultRenderer"
                      recommendServletURL="[ URL to invoke RecommendServletHandler (set up in web.xml) ]"
                      linkLabel="[ label for hyperlink - e.g. "Recommend this document" ]" >

     <!-- map of result field values to http parameters -->
     <ResultRequestMap>
       <Field ID="[ result field name ]" requestParam="[ name of http request parameter ]" />
     </ResultRequestMap>

     <!-- Fixed parameters to be added to http request -->
     <FixedParam name="[ name of http parameter ]" value="[ value of parameter ]" />

   </ResultRenderer>
 

Developed by Raritan Technologies .

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

RecommendThisResultRenderer()

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

RecommendThisResultRenderer

public RecommendThisResultRenderer()

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

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