com.raritantechnologies.searchApp.formatters
Class DynamicFormatter

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

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class DynamicFormatter

extends java.lang.Object

implements IFieldFormatter

Dynamically switches an IFieldFormatter based on the properties of the IResult formatted. Uses IResultMatcher objects to determine which nested IFieldFormatter to use.

XML Configuration Template;

   <Formatter 
      formatterClass="com.raritantechnologies.searchApp.formatters.DynamicFormatter" >

     <!-- If this ResultMatcher matches the target result; the companion Formatter will be used -->
     <UseFormatter>
       <ResultMatcher class="[class of com.raritantechnologies.searchApp.IResultMatcher]" >
         <!-- configuration parameters for result matcher -->
       </ResultMatcher>

       <Formatter class="[class of com.raritantechnologies.searchApp.IFieldFormatter]" >
         <!-- configuration parameters for formatter -->
       </Formatter>
     </UseFormatter>

     <!-- If first matcher doesn't match and this matcher does its formatter will be used -->
     <UseFormatter>
       <ResultMatcher class="[class of com.raritantechnologies.searchApp.IResultMatcher]" >
         <!-- configuration parameters for result matcher -->
       </ResultMatcher>

       <Formatter class="[class of com.raritantechnologies.searchApp.IFieldFormatter]" >
         <!-- configuration parameters for formatter -->
       </Formatter>
     </UseFormatter>

   </Formatter>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

DynamicFormatter()

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 res) Formats a result field "in place".
void	formatResultField(java.lang.String sessionID, IResult res) 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.
void	initialize(org.w3c.dom.Element elem) Initializes the formatter from configuration XML element.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicFormatter

public DynamicFormatter()

Method Detail

formatResultField

public void formatResultField(IResult res)

Description copied from interface: IFieldFormatter

Formats a result field "in place".

Specified by:

formatResultField in interface IFieldFormatter

Parameters:

res - The result object that is to be formatted.

formatResultField

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

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.

res - 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 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.

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.

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