com.raritantechnologies.quickstart.taglibrary.request
Class RequestResultMapper

java.lang.Object
  com.raritantechnologies.quickstart.taglibrary.request.RequestResultMapper

All Implemented Interfaces:

IConfigurable, IRequestFormatter

public class RequestResultMapper

extends java.lang.Object

implements IConfigurable, IRequestFormatter

Converts an HTTP request to an IResult - using basic parameter mapping. This enables standard RTI IResultRenderers to be used to format the request.

XML Configuration Template:

   <SystemObject type="RequestFormatter"
                 configurableClass="com.raritantechnologies.quickstart.taglibrary.request.RequestResultMapper" >

     <!-- Maps HTTP request fields to IResult fields -->
     <RequestResultMap>
       <Param reqParam="[requestID 1]" resultID="resultID 1" /> 
       <Param reqParam="[requestID 2]" resultID="resultID 2" /> 
     </RequestResultMap>

     <!-- Optional Cache Map - maps fields in SessionData cache to fields in IResult -->
     <CacheResultMap>
       <Param cacheParam="[cached parameter 1]" resultID="resultID 3" /> 
       <Param cacheParam="[cached parameter 2]" resultID="resultID 4" /> 
     </CacheResultMap>

     <!-- Optional Result Field Formatter -->
     <Formatter class="[some com.raritantechnologies.searchApp.IFieldFormatter class]" >
        <!-- configuration parameters of Formatter --> 
     </Formatter>

     <!-- Result Renderer that will be used to format the IResult into a String -->
     <ResultRenderer rendererClass="[some com.raritantechnologies.searchApp.taglibrary.IResultRenderer class]" >
         <!-- ResultRenderer config params here . . . -->
     </ResultRenderer>

   </SystemObject>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

RequestResultMapper()

Method Summary

IResult	createResult(RaritanPageContext rpc)
java.lang.String	formatSearchRequest(RaritanPageContext rpc) Reformat the http request as a String.
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

RequestResultMapper

public RequestResultMapper()

Method Detail

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

createResult

public IResult createResult(RaritanPageContext rpc)

formatSearchRequest

public java.lang.String formatSearchRequest(RaritanPageContext rpc)

Description copied from interface: IRequestFormatter

Reformat the http request as a String.

Specified by:

formatSearchRequest in interface IRequestFormatter