com.raritantechnologies.webServices
Class PatternWebServiceFormatter

java.lang.Object
  com.raritantechnologies.webServices.PatternWebServiceFormatter

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class PatternWebServiceFormatter

extends java.lang.Object

implements IFieldFormatter

Generates a WebServices request using a XML Pattern Input. Uses a WebServiceStringFilter to execute the command. The returned XML is put into an output IResult field.

XML Configuration Template:

  <Formatter 
         formatterClass="com.raritantechnologies.webServices.PatternWebServiceFormatter" 
         templateFileName="[ file name of Velocity Template ]" >

    <WebServiceStringFilter>

    </WebServiceStringFilter>

    <!-- XMLResultProcessor -- transformed returned SOAP response to a nested IResultSet -->
    <XMLResultProcessor resultTagName="[name for result tags]" 
                     addResultID="true" 
                     debug="true|false" >
       
          IResult 
          
              Documents
          
       
    </XMLResultProcessor>

    <!-- Fixed Velocity Context Fields -->
    <ContextFields>

    </ContextFields>
  </Formatter>

 

Author:

Pat Crabtree

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

PatternWebServiceFormatter()

Method Summary

java.lang.String	formatField(java.lang.String fieldVal) Reformats a field value.
java.lang.String	formatField(java.lang.String sessionID, java.lang.String fieldVal) Reformats a field value.
void	formatResultField(IResult result) Formats a result field "in place".
void	formatResultField(java.lang.String sessionID, IResult result) Formats a result field "in place", incorporating session context.
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
java.lang.String	getFieldName() Returns the name of the result field that this formatter can reformat.
IStringFilter	getWebServiceFilter()
void	initialize(org.w3c.dom.Element elem) Initializes the formatter from configuration XML element.
void	setWebServiceFilter(WebServiceStringFilter webServiceFilter)

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternWebServiceFormatter

public PatternWebServiceFormatter()

Method Detail

formatResultField

public void formatResultField(java.lang.String sessionID,
                              IResult result)

Description copied from interface: IFieldFormatter

Formats a result field "in place", incorporating session context.

Specified by:

formatResultField in interface IFieldFormatter

Parameters:

sessionID - The session key needed to lookup any session content stored in the session data cache.

result - The result object that is to be formatted.

formatResultField

public void formatResultField(IResult result)

Formats a result field "in place".

Specified by:

formatResultField in interface IFieldFormatter

Parameters:

result - The result object that is to be formatted.

getFieldName

public java.lang.String getFieldName()

Returns the name of the result field that this formatter can reformat.

Specified by:

getFieldName in interface IFieldFormatter

formatField

public java.lang.String formatField(java.lang.String sessionID,
                                    java.lang.String fieldVal)

Reformats a field value.

Specified by:

formatField in interface IFieldFormatter

Parameters:

sessionID - The session key needed to lookup any session content stored in the session data cache.

fieldVal - The field value to be reformatted.

Returns:

The reformatted field value.

formatField

public java.lang.String formatField(java.lang.String fieldVal)

Description copied from interface: IFieldFormatter

Reformats a field value.

Specified by:

formatField in interface IFieldFormatter

Parameters:

fieldVal - The field value to be reformatted.

Returns:

The reformatted field value.

initialize

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

Description copied from interface: IFieldFormatter

Initializes the formatter from configuration XML element.

Specified by:

initialize in interface IFieldFormatter

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IFieldFormatter

getConfigurationXML

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

Specified by:

getConfigurationXML in interface IFieldFormatter

getWebServiceFilter

public IStringFilter getWebServiceFilter()

setWebServiceFilter

public void setWebServiceFilter(WebServiceStringFilter webServiceFilter)