com.raritantechnologies.searchApp.taglibrary
Interface IResultRenderer

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

AppendingResultRenderer, AtomResultRenderer, BasicResultRenderer, CategoryLinkRenderer, CheckboxResultRenderer, ClassifierResultRenderer, DelimitedFieldRenderer, DivResultRenderer, DropdownMenuLinkRenderer, DynamicResultRenderer, FieldHyperlinkRenderer, FieldRangeImageRenderer, FieldSecurityResultRenderer, GetFormHyperlinkRenderer, HiddenFieldRenderer, HighlightingResultRenderer, IDOLResultRenderer, ImageFieldHyperlinkRenderer, ImageMapHyperlinkRenderer, JSONResultRenderer, LabeledFieldRenderer, LabelRenderer, MetaDataFieldRenderer, MimeTypeFieldRenderer, ModelingResultRenderer, MultipleValueResultRenderer, NestedResultRenderer, NullRenderer, PatternResultRenderer, PopupFieldResultRenderer, ReadOnlyElement, RecommendedDocsResultRenderer, RecommendThisResultRenderer, ResultAnnotatorRenderer, ResultColumnRenderer, ResultNumberRenderer, ResultRowRenderer, ResultToQueryRenderer, RSSResultRenderer, ScoreFieldRenderer, SecureResultRenderer, SelectTrainableClassifiersCheckboxRenderer, SimpleFieldRenderer, SimpleImageRenderer, SizeFieldRenderer, SourceMapLinkResultRenderer, SourceMapSearchResultRenderer, SystemObjectResultRenderer, TabbedResultRenderer, TableResultRenderer, TaggingResultRenderer, ToggleDivLinkResultRenderer, TreeResultRenderer, XMLResultProcessorRenderer, XSLResultRenderer

public interface IResultRenderer

extends IConfigurable

Base interface for result rendering.

An IResultRenderer renders a single IResult to an HTML fragment.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

static java.lang.String

TEMPLATE

Method Summary

java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
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.

Field Detail

TEMPLATE

public static final java.lang.String TEMPLATE

See Also:

Constant Field Values

Method Detail

initialize

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

IResultRenderers are XML configurable.

Specified by:

initialize in interface IConfigurable

getConfigurationXML

public java.lang.String getConfigurationXML()

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)

renderResult

public 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.

setEnable

public void setEnable(boolean enabled)

provides show/hide control.

isEnabled

public boolean isEnabled()

getRenderer

public IResultRenderer getRenderer(java.lang.String name)

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