com.raritantechnologies.searchApp.taglibrary
Class BasicResultRenderer

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

All Implemented Interfaces:

IConfigurable, IPreferencesBeanInfo, IResultRenderer

Direct Known Subclasses:

AppendingResultRenderer, CategoryLinkRenderer, CheckboxResultRenderer, ClassifierResultRenderer, DelimitedFieldRenderer, DivResultRenderer, DropdownMenuLinkRenderer, DynamicResultRenderer, FieldHyperlinkRenderer, FieldRangeImageRenderer, FormattingResultRenderer, GetFormHyperlinkRenderer, HiddenFieldRenderer, HighlightingResultRenderer, ImageFieldHyperlinkRenderer, ImageMapHyperlinkRenderer, LabeledFieldRenderer, LabelRenderer, MetaDataFieldRenderer, MimeTypeFieldRenderer, ModelingResultRenderer, MultipleValueResultRenderer, NullRenderer, ReadOnlyElement, RecommendedDocsResultRenderer, RecommendThisResultRenderer, ResultAnnotatorRenderer, ResultColumnRenderer, ResultNumberRenderer, ResultRowRenderer, ResultToQueryRenderer, ScoreFieldRenderer, SecureResultRenderer, SimpleFieldRenderer, SimpleImageRenderer, SizeFieldRenderer, SourceMapLinkResultRenderer, SourceMapSearchResultRenderer, TabbedResultRenderer, TableResultRenderer, TaggingResultRenderer, ToggleDivLinkResultRenderer, XMLResultProcessorRenderer, XSLResultRenderer

public abstract class BasicResultRenderer

extends java.lang.Object

implements IResultRenderer, IPreferencesBeanInfo

Abstract base implementation of IResultRenderer. Handles enable/diable toggling, name handling. Renders a single IResult to an HTML fragment.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

protected boolean	enabled
protected java.lang.String	name
protected java.lang.String	prefBeanName
protected java.lang.String	prefCompareValue
protected java.lang.String	prefEnableIfInChecklist
protected java.lang.String	prefEnableIfInYesno

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

TEMPLATE

Constructor Summary

BasicResultRenderer()

Method Summary

protected abstract java.lang.String	doRenderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext)
java.lang.String	getPrefBeanName()
java.lang.String	getPrefCompareValue()
java.lang.String	getPrefEnableIfInChecklist()
java.lang.String	getPrefEnableIfInYesno()
IResultRenderer	getRenderer(java.lang.String name) Provides for nested result renderers.
void	initialize(org.w3c.dom.Element elem) IResultRenderers are XML configurable.
boolean	isEnabled()
java.lang.String	renderResult(IResult result, int firstResult, int lastResult, int resultNum, RaritanPageContext pageContext) return an HTML fragment using the data contained within the IResult object.
void	setEnable(boolean enabled) provides show/hide control.

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

getConfigurationXML, getConfigurationXML

Field Detail

name

protected java.lang.String name

enabled

protected boolean enabled

prefBeanName

protected java.lang.String prefBeanName

prefCompareValue

protected java.lang.String prefCompareValue

prefEnableIfInChecklist

protected java.lang.String prefEnableIfInChecklist

prefEnableIfInYesno

protected java.lang.String prefEnableIfInYesno

Constructor Detail

BasicResultRenderer

public BasicResultRenderer()

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

setEnable

public void setEnable(boolean enabled)

Description copied from interface: IResultRenderer

provides show/hide control.

Specified by:

setEnable in interface IResultRenderer

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface IResultRenderer

getRenderer

public IResultRenderer getRenderer(java.lang.String name)

Description copied from interface: IResultRenderer

Provides for nested result renderers. returns an instance of IResultRenderer or null if result renderer of given name is not found.

Specified by:

getRenderer in interface IResultRenderer

renderResult

public java.lang.String renderResult(IResult result,
                                     int firstResult,
                                     int lastResult,
                                     int resultNum,
                                     RaritanPageContext pageContext)

Description copied from interface: IResultRenderer

return an HTML fragment using the data contained within the IResult object.

Specified by:

renderResult in interface IResultRenderer

getPrefBeanName

public java.lang.String getPrefBeanName()

Specified by:

getPrefBeanName in interface IPreferencesBeanInfo

getPrefCompareValue

public java.lang.String getPrefCompareValue()

Specified by:

getPrefCompareValue in interface IPreferencesBeanInfo

getPrefEnableIfInChecklist

public java.lang.String getPrefEnableIfInChecklist()

Specified by:

getPrefEnableIfInChecklist in interface IPreferencesBeanInfo

getPrefEnableIfInYesno

public java.lang.String getPrefEnableIfInYesno()

Specified by:

getPrefEnableIfInYesno in interface IPreferencesBeanInfo

doRenderResult

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