com.raritantechnologies.xml.dataCollection.rss
Class RSSResultRenderer

java.lang.Object
  com.raritantechnologies.xml.dataCollection.rss.RSSResultRenderer

All Implemented Interfaces:

IConfigurable, IResultRenderer

public class RSSResultRenderer

extends java.lang.Object

implements IResultRenderer

Renders an IResult as RSS XML.

XML Configuration Template:

  <ResultRenderer class="com.raritantechnologies.xml.dataCollection.rss.RSSResultRenderer" >

    <!-- Mapping of IResult fields to RSS fields -->
    <Fields>
      <Field ID="[ result ID ]" rssField="[ URL | TITLE | DESCRIPTION | PUBLISH_DATE ]" />
    </Fields>

  </ResultRenderer>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

static java.lang.String	DESCRIPTION_FIELD
static java.lang.String	GUID_FIELD
static java.lang.String	PUBDATE_FIELD
static java.lang.String	TITLE_FIELD
static java.lang.String	URL_FIELD

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

TEMPLATE

Constructor Summary

RSSResultRenderer()

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) Initialize fields that will be used to create the RSS XML record.
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.
void	setResultFieldMap(java.util.Map resultFieldMap)

Methods inherited from class java.lang.Object

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

Field Detail

URL_FIELD

public static final java.lang.String URL_FIELD

See Also:

Constant Field Values

TITLE_FIELD

public static final java.lang.String TITLE_FIELD

See Also:

Constant Field Values

DESCRIPTION_FIELD

public static final java.lang.String DESCRIPTION_FIELD

See Also:

Constant Field Values

GUID_FIELD

public static final java.lang.String GUID_FIELD

See Also:

Constant Field Values

PUBDATE_FIELD

public static final java.lang.String PUBDATE_FIELD

See Also:

Constant Field Values

Constructor Detail

RSSResultRenderer

public RSSResultRenderer()

Method Detail

setResultFieldMap

public void setResultFieldMap(java.util.Map resultFieldMap)

initialize

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

Initialize fields that will be used to create the RSS XML record.

Specified by:

initialize 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

setEnable

public void setEnable(boolean enabled)

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

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