com.raritantechnologies.quickstart.taglibrary
Class HighlightingDisplayFormRenderer

java.lang.Object
  com.raritantechnologies.quickstart.taglibrary.HighlightingDisplayFormRenderer

All Implemented Interfaces:

IConfigurable, IDisplayFormRenderer

Direct Known Subclasses:

LookupHighlightingDisplayFormRenderer

public class HighlightingDisplayFormRenderer

extends java.lang.Object

implements IDisplayFormRenderer

Globally highlights and renderers a DisplayForm's view of results.

Requires a child renderer to render the data, applies highlighting to the result. If you want to highlight an individual field in a result, use the HighlightingResultRenderer.

 
 <DisplayForm name="formName" 
              rendererClass="com.raritantechnologies.quickstart.taglibrary.HighlightingDisplayFormRenderer" 
              hlBegin="&lt;b&gt;"
              hlEnd="&lt;/b&gt;"
              queryParam="[ one or more query parameters that contain highlight term ]"
              minWordLength="3"
              delimiter=" ,." >

      <StopWords>
          <StopWord>ignore word 1</StopWord>
          <StopWord>ignore word 2</StopWord>
      </StopWords>

      <DisplayFormRenderer rendererClass ="IDisplayFormRenderer class" >

      </DisplayFormRenderer>
  </DisplayForm>
  

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

static boolean	DEBUG
protected int	minWordLength
protected java.util.HashSet	stopWords

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

TEMPLATE

Constructor Summary

HighlightingDisplayFormRenderer()

Method Summary

void	addBodyTrailerContent(java.lang.String content) Add html content to be appended to the body of the displayFormRenderer
protected java.lang.String	cleanQueryVal(java.lang.String queryVal)
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 display form body as an HTML fragment, by formatting the data contained in an IResultSet.
protected java.util.Set	getQueryVal(OrderedMap qParams)
IResultRenderer	getResultRenderer(java.lang.String name)
void	initialize(org.w3c.dom.Element elem) Initialize the display form renderer from the configuration XML.
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

DEBUG

public static final boolean DEBUG

See Also:

Constant Field Values

stopWords

protected java.util.HashSet stopWords

minWordLength

protected int minWordLength

Constructor Detail

HighlightingDisplayFormRenderer

public HighlightingDisplayFormRenderer()

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

getBody

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

Description copied from interface: IDisplayFormRenderer

Returns the display form body as an HTML fragment, by formatting the data contained in an IResultSet.

Specified by:

getBody in interface IDisplayFormRenderer

getQueryVal

protected java.util.Set getQueryVal(OrderedMap qParams)

cleanQueryVal

protected java.lang.String cleanQueryVal(java.lang.String queryVal)

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

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