com.raritantechnologies.verity.taglibrary
Class DidYouMeanDisplayFormRenderer

java.lang.Object
  com.raritantechnologies.verity.taglibrary.DidYouMeanDisplayFormRenderer

All Implemented Interfaces:

IConfigurable, IDisplayFormRenderer

public class DidYouMeanDisplayFormRenderer

extends java.lang.Object

implements IDisplayFormRenderer

Did You Mean display form. Display DID YOU MEAN terms if few hits.

XML Configuration Template:

  <DisplayForm name="didyoumean" 
      rendererClass="com.raritantechnologies.quickstart.taglibrary.DidYouMeanDisplayFormRenderer"
      threshold="1"	( display did you mean if this number of results or fewer )
      prefBeanName="UserPrefs" (name of PreferencesBean -- if any)
      prefName="DidYouMean"    (preference name for the did you mean preference)
		suggestionRegex="[a-zA-Z0-9]"	(regex for valid characters in a suggestion)
      >
  </DisplayForm>
 

NOTE: the threshold parameter is ignored if prefBeanName is set, and a refers to a valid PreferencesBean object. NOTE: suggestionRegex can be used to reject suggestions with special characters in them.
Developed by Raritan Technologies .

Author:

Glenn Robitaille

Field Summary

protected java.lang.StringBuffer

trailerBuffer

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

TEMPLATE

Constructor Summary

DidYouMeanDisplayFormRenderer()

Method Summary

void	addBodyTrailerContent(java.lang.String content) Add html content to be appended to the body of the displayFormRenderer
void	disableRenderers(java.util.HashSet disabledRenderers)
void	enableRenderers(java.util.HashSet enabledRenderers)
java.lang.String	getBody(IResultSet theResults, java.lang.String displayFormName, RaritanPageContext pageContext) returns the HTML fragment for the given set of results.
IResultRenderer	getResultRenderer(java.lang.String name)
java.lang.String	getSuggestion(java.lang.String k2ServerSpec, java.lang.String userName, java.lang.String password, java.lang.String query, java.lang.String collectionName)
void	initialize(org.w3c.dom.Element elem) Initialize the display form renderer from the configuration XML.
void	initialize(java.util.Map renderParams) Initialize the display form renderer from a set of configuration parameters.
void	setDisabledRendererParam(java.lang.String disabledParam)
void	setEnabledRendererParam(java.lang.String enabledParam)
void	setEnabledRenderers(java.lang.String displayForm, RaritanPageContext pageContext)

Methods inherited from class java.lang.Object

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

Field Detail

trailerBuffer

protected java.lang.StringBuffer trailerBuffer

Constructor Detail

DidYouMeanDisplayFormRenderer

public DidYouMeanDisplayFormRenderer()

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Initialize the display form renderer from the configuration XML.

Specified by:

initialize in interface IDisplayFormRenderer

initialize

public void initialize(java.util.Map renderParams)

Initialize the display form renderer from a set of configuration parameters.

getBody

public java.lang.String getBody(IResultSet theResults,
                                java.lang.String displayFormName,
                                RaritanPageContext pageContext)

returns the HTML fragment for the given set of results.

Specified by:

getBody in interface IDisplayFormRenderer

addBodyTrailerContent

public void addBodyTrailerContent(java.lang.String content)

Description copied from interface: IDisplayFormRenderer

Add html content to be appended to the body of the displayFormRenderer

Specified by:

addBodyTrailerContent in interface IDisplayFormRenderer

getResultRenderer

public IResultRenderer getResultRenderer(java.lang.String name)

Specified by:

getResultRenderer in interface IDisplayFormRenderer

getSuggestion

public java.lang.String getSuggestion(java.lang.String k2ServerSpec,
                                      java.lang.String userName,
                                      java.lang.String password,
                                      java.lang.String query,
                                      java.lang.String collectionName)

setEnabledRendererParam

public void setEnabledRendererParam(java.lang.String enabledParam)

Specified by:

setEnabledRendererParam in interface IDisplayFormRenderer

setDisabledRendererParam

public void setDisabledRendererParam(java.lang.String disabledParam)

Specified by:

setDisabledRendererParam in interface IDisplayFormRenderer

setEnabledRenderers

public void setEnabledRenderers(java.lang.String displayForm,
                                RaritanPageContext pageContext)

Specified by:

setEnabledRenderers in interface IDisplayFormRenderer

enableRenderers

public void enableRenderers(java.util.HashSet enabledRenderers)

Specified by:

enableRenderers in interface IDisplayFormRenderer

disableRenderers

public void disableRenderers(java.util.HashSet disabledRenderers)

Specified by:

disableRenderers in interface IDisplayFormRenderer