com.raritantechnologies.concept.classifier
Class ClassifierResultRenderer

java.lang.Object
  com.raritantechnologies.searchApp.taglibrary.BasicResultRenderer
      com.raritantechnologies.concept.classifier.ClassifierResultRenderer

All Implemented Interfaces:

IConfigurable, IPreferencesBeanInfo, IResultRenderer

public class ClassifierResultRenderer

extends BasicResultRenderer

implements IResultRenderer

Renders a classifier rule that has been assigned to an IResult by finding the IDocumentMatcher identified by a matcherNameField and DocumentClassifier name. The DocumentClassifier is typically used as an IFieldFormatter that will "tag" the IResult with the names of one or more IDocumentMatcher that match the IResult metadata. This renderer enables these matcher rules to be displayed.

XML Configuration Template:

   <ResultRenderer class="com.raritantechnologies.concept.classifier.ClassifierResultRenderer"
                      documentClassifier="[ name of DocumentClassifier instance ]"
                      matcherNameField="[ result field that contains the IDocumentMatcher name for this classifier ]"
                      multipleValueSeparator="[ string to use to separate multiple Document matchers: e.g. '&br>' ]" />
 

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

ClassifierResultRenderer()

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

ClassifierResultRenderer

public ClassifierResultRenderer()

Method Detail

doRenderResult

protected java.lang.String doRenderResult(IResult result,
                                          int firstResult,
                                          int lastResult,
                                          int resultNum,
                                          RaritanPageContext pageContext)

Specified by:

doRenderResult in class BasicResultRenderer

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

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