com.raritantechnologies.quickstart.taglibrary
Class TaggingResultRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      com.raritantechnologies.quickstart.taglibrary.TaggingResultRenderer

All Implemented Interfaces:

IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class TaggingResultRenderer

extends BasicResultRenderer

implements IResultRenderer

Tags single words with hyperlink. Wraps another IResultRenderer - applies tagging (example: hyperlinking) operation to the output of the nested ResultRenderer using an ITagWriter.

XML Configuration Template:

   <ResultRenderer 
        rendererClass="com.raritantechnologies.quickstart.taglibrary.TaggingResultRenderer"
        tagSourceField="[ (optional) field or fields in result that contains tag source words ]"
        makeThreadSafe="[true(default)|false - uses session bound tag writer if true ]"
        insideATag="[true|false(default) - if true will insert tags within <a> tags ]" >

     <!-- Nested result renderer provides initial rendering -->
     <ResultRenderer rendererClass ="IResultRenderer class" >
        <!-- configuration parameters for nested result renderer -->
     </ResultRenderer>

     <!-- TagWriter marks up the rendered output of the nested renderer -->
     <TagWriter taggingClass= "ITagWriter class" >
         Tagging specific information...
     </TagWriter>

     <!-- Optional ITermExtractor: Will tag the output of the nested Result Renderer OR the -->
     <!-- values in the IResult tagSourceField attribute                                    -->
     <TermExtractor class="[ class of com.raritantechnologies.utils.tagging.ITermExtractor ]" >

     </TermExtractor>

   </ResultRenderer>
 

Developed by Raritan Technologies Inc..

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

TaggingResultRenderer()

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	getConfigurationXML(java.io.Writer writer)
IResultRenderer	getInitialRenderer()
ITagWriter	getTagWriter()
void	initialize(org.w3c.dom.Element elem) IResultRenderers are XML configurable.
void	setInitialRenderer(IResultRenderer initialRenderer)
void	setTagWriter(ITagWriter tagWriter)

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

TaggingResultRenderer

public TaggingResultRenderer()

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

setInitialRenderer

public void setInitialRenderer(IResultRenderer initialRenderer)

getInitialRenderer

public IResultRenderer getInitialRenderer()

setTagWriter

public void setTagWriter(ITagWriter tagWriter)

getTagWriter

public ITagWriter getTagWriter()

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException

Throws:

java.io.IOException

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