com.raritantechnologies.quickstart.taglibrary
Class LookupHighlightingDisplayFormRenderer

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

All Implemented Interfaces:

IConfigurable, IDisplayFormRenderer

public class LookupHighlightingDisplayFormRenderer

extends HighlightingDisplayFormRenderer

Uses a lookup source to generate terms for use by HighlightingDisplayFormRenderer.

XML Configuration Template:

  <DisplayForm name="formName" 
              rendererClass="com.raritantechnologies.quickstart.taglibrary.LookupHighlightingDisplayFormRenderer" 
              hlBegin="&lt;b&gt;"
              hlEnd="&lt;/b&gt;"
              minWordLength="3"
              delimiter=" ,."
              searchSourceName="[ name of search source to look up highlight terms ]" >

      <!-- List of Result fields to be used as search source query parameters -->
      <SearchParams>
        <Param ID="[ field in result ]" searchParam="[ field in search request ]" />
      </SearchParams>

      <!-- List of lookup result fields to be used to get highlight terms -->
      <ResultFields>
        <Field ID="[ field in lookup result ]" />
      </ResultFields>

      <!-- Optional list of IFieldFormatters that will format lookup results before highlighting -->
      <FieldFormatter class="[ class of com.raritantechnologies.searchApp.IFieldFormatter ]" >

      </FieldFormatter>

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

      <!-- The delegate DisplayFormRenderer that gets the initial text to highlight -->
      <DisplayFormRenderer rendererClass ="IDisplayFormRenderer class" >

      </DisplayFormRenderer>
  </DisplayForm>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.quickstart.taglibrary.HighlightingDisplayFormRenderer

minWordLength, stopWords

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

TEMPLATE

Constructor Summary

LookupHighlightingDisplayFormRenderer()

Method Summary

protected java.util.Set	getQueryVal(OrderedMap qParams)
void	initialize(org.w3c.dom.Element elem) Initialize the display form renderer from the configuration XML.

Methods inherited from class com.raritantechnologies.quickstart.taglibrary.HighlightingDisplayFormRenderer

addBodyTrailerContent, cleanQueryVal, disableRenderers, enableRenderers, getBody, getResultRenderer, setDisabledRendererParam, setEnabledRendererParam, setEnabledRenderers

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupHighlightingDisplayFormRenderer

public LookupHighlightingDisplayFormRenderer()

Method Detail

getQueryVal

protected java.util.Set getQueryVal(OrderedMap qParams)

Overrides:

getQueryVal in class HighlightingDisplayFormRenderer

initialize

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

Description copied from class: HighlightingDisplayFormRenderer

Initialize the display form renderer from the configuration XML.

Specified by:

initialize in interface IDisplayFormRenderer

Overrides:

initialize in class HighlightingDisplayFormRenderer