com.raritantechnologies.searchApp.formatters
Class XMLResultProcessorFormatter

java.lang.Object
  com.raritantechnologies.searchApp.formatters.XMLResultProcessorFormatter

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class XMLResultProcessorFormatter

extends java.lang.Object

implements IFieldFormatter

Uses an XMLResultProcessor to format an IResult from a contained XML field.

XML Configuration Template:

  <Formatter
     formatterClass="com.raritantechnologies.searchApp.formatters.XMLResultProcessorFormatter" 
     xmlFieldID="[ field that contains the input XML ]"
     nestedTagName="[ optional nested tag to get result(s) from ]"
     nestedResultName="[ name to use for adding results as nested results ]"
     resultTag="[ name of single result tag if adding nested result set ]"
     multiple="true|false(default)" >

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

  </Formatter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

XMLResultProcessorFormatter()

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)
void	getConfigurationXML(java.io.Writer writer)
java.lang.String	getFieldName() Returns the name of the result field that this formatter can reformat.
java.lang.String	getResultXMLField()
XMLResultProcessor	getXMLResultProcessor()
void	initialize(org.w3c.dom.Element elem) Initializes the formatter from configuration XML element.
void	setResultXMLField(java.lang.String resultXMLField)
void	setXMLResultProcessor(XMLResultProcessor xmlProcessor)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLResultProcessorFormatter

public XMLResultProcessorFormatter()

Method Detail

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

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)

Description copied from interface: IFieldFormatter

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()

Description copied from interface: IFieldFormatter

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)

Description copied from interface: IFieldFormatter

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.

setResultXMLField

public void setResultXMLField(java.lang.String resultXMLField)

getResultXMLField

public java.lang.String getResultXMLField()

setXMLResultProcessor

public void setXMLResultProcessor(XMLResultProcessor xmlProcessor)

getXMLResultProcessor

public XMLResultProcessor getXMLResultProcessor()

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 IFieldFormatter

getConfigurationXML

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

Specified by:

getConfigurationXML in interface IFieldFormatter