com.raritantechnologies.recommend.taglibrary
Class RecommendedDocsResultRenderer

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

All Implemented Interfaces:

IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class RecommendedDocsResultRenderer

extends BasicResultRenderer

implements IResultRenderer

Provides a set of see-also links related to the rendered result using an IRecommend Recommendation Engine. Uses metadata from the current result to see if there are any documents that are recommended by the Recommendation engine - if so, displays the recommended documents using an IDisplayFormRenderer.

XML Configuration Template:

   <ResultRenderer class="com.raritantechnologies.recommend.taglibrary.RecommendDocsResultRenderer"
                      recommendationEngineName="[ name of IRecommend SystemObject ]"
                      recommendationMode="[ DOCUMENTS| USERS | QUERIES ]"
                      repositories="[ comma separated list of Recommendation repositories ]"
                      docFields="[ comma separated list of result fields to use for recommendation ]"
                      nRecommendedDocs="[ number of recommendations to get (default=5) ]"
                      displayFormName="[ name of system DisplayForm ]"
                      docURLField="[ document URL field name ]"
                      docIDField="[ document ID field name ]"
                      docFullTextField="[ document Full Text field name ]"
                      docTitleField="[ document Title field name ]" >

      <!-- Can define RecommendationEngine locally: -->
      <RecommendationEngine class="[ class of com.raritantechnologies.recommend.IRecommend ]" >

      </RecommendationEngine>

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

      </DisplayFormRenderer>

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

RecommendedDocsResultRenderer()

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

RecommendedDocsResultRenderer

public RecommendedDocsResultRenderer()

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