com.raritantechnologies.utils.filter
Class XMLResultProcessorFilter

java.lang.Object
  com.raritantechnologies.utils.filter.XMLResultProcessorFilter

All Implemented Interfaces:

IConfigurable, IStringFilter

public class XMLResultProcessorFilter

extends java.lang.Object

implements IStringFilter

Transforms an XML String into an XMLResultSet and then renders the result set using an com.raritantechnologies.taglibrary.IDisplayFormRenderer.

XML Configuration Template:

   <StringFilter class="com.raritantechnologies.utils.filter.XMLResultProcessorFilter"
                    recordTag="[ name of tag in XML string that has result record ]"
                    requestParameters="[ comma separated list of session request parameters ]" >

      <DisplayFormRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.IDisplayFormRenderer ]" >

      </DisplayFormRenderer>

      <!-- Alternatively can render a single result: -->
      <ResultRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.IResultRenderer ]" >

      </ResultRenderer>

      <XMLResultProcessor>
        <!-- See XMLResultProcessor for configuration details -->
      </XMLResultProcessor>

   </StringFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.utils.filter.IStringFilter

TEMPLATE

Constructor Summary

XMLResultProcessorFilter()

Method Summary

java.lang.String	filterString(java.util.Map parameters, java.lang.String inputString)
java.lang.String	filterString(java.lang.String inputString)
java.lang.String	filterString(java.lang.String sessionID, java.lang.String inputString)
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
void	getConfigurationXML(java.io.Writer writer)
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

XMLResultProcessorFilter

public XMLResultProcessorFilter()

Method Detail

filterString

public java.lang.String filterString(java.lang.String sessionID,
                                     java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.util.Map parameters,
                                     java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

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

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IStringFilter

getConfigurationXML

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

Specified by:

getConfigurationXML in interface IStringFilter