com.raritantechnologies.xml.dataCollection.rss
Class RSSSearchSource

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

All Implemented Interfaces:

IConfigurable

public class RSSSearchSource

extends java.lang.Object

implements IConfigurable

Uses an RTI SearchSource to retrieve results and a specialized RSSDisplayFormRenderer to transform the data into RSS XML format. Works with RSSServlet to provide a RSS source that can be coupled to any back-end RTI Search Source.

RSS feeds can be based on saved queries, request parameters or static (pre-defined) query parameters.

XML Configuration Template:

   <SystemObject type="RSSSearchSource" 
                    configurableClass="com.raritantechnologies.xml.dataCollection.rss.RSSSearchSource"
                    searchSource="[ name of an RTI SearchSource ]"
                    pageSize=" page size for output RSS output " >


     <!-- Defines the set of http request parameters that will be used to query the source -->
     <RequestParameters>
       <Param name="[ http request parameter ]" />
       <Param name="[ another http parameter ]" />
       <!-- etc... -->
     </RequestParameters>

     <!-- Defines the set of user parameters that will be used to query the source -->
     <UserParameters>
       <Param name="[ user parameter ]" />
       <Param name="[ another user parameter ]" />
       <!-- etc... -->
     </UserParameters>

     <!-- static parameters that will be added to the RSS source query -->
     <StaticParameters>
       <Param name="[ parameter name ]" value="[ parameter value ]" />
       <Param name="[ another name ]" value="[ another value ]" />
       <!-- etc... -->
     </StaticParameters>

     <!-- Alternatively: can use a SearchSource to get the query parameters for the RSS source: -->
     <QuerySource name="[ search source name ]" >

        <!-- Describes mapping of result parameter --> query parameter -->
        <ResultParameters>
          <Param resultParam="[ name of field in result ]" queryParam="[ name of parameter in query ]" />
          <Param resultParam="[ another field in result ]" queryParam="[ another parameter in query ]" />
          <!-- etc... -->
        </ResultParameters>

     </QuerySource>

     <!-- Alternatively: can use a saved query / result set as a RSS source -->
     <QueryResultReader class="[ class of com.raritantechnologies.searchApp.query.IQueryResultSetReader ]" >
         <!-- Configuration Parameters for QueryResultReader -->
     </QueryResultReader>

     <!-- Optional IResultSetProcessor to provide pre-processing -->
     <ResultSetProcessor class="[ class of com.raritantechnologies.searchApp.IResultSetProcessor ]" >
         <!-- Configuration Parameters for ResultSetProcessor -->
     </ResultSetProcessor>

     <!-- RSSDisplayFormRenderer converts results to RSS XML format.-->
     <RSSDisplayFormRenderer>
         <!-- Configuration Parameters for RSSDisplayFormRenderer -->
     </RSSDisplayFormRenderer>

   </SystemObject>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

RSSSearchSource()

Method Summary

java.lang.String	getRSSData(RaritanPageContext pContext)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Constructor Detail

RSSSearchSource

public RSSSearchSource()

Method Detail

getRSSData

public java.lang.String getRSSData(RaritanPageContext pContext)

initialize

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

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable