com.raritantechnologies.searchApp.formatters
Class ResultMatcherFormatter

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

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class ResultMatcherFormatter

extends java.lang.Object

implements IFieldFormatter

Formatter that sets the value of a result field based on the output of an IResultMatcher. If the IResultMatcher matches, the "trueValue" is used, else the "falseValue" is used.

XML Configuration Template:

   <FieldFormatter formatterClass="com.raritantechnologies.searchApp.formatters.ResultMatcherFormatter"
                      fieldID="[ field of output value ]"
                      trueValue="[ value to put in output field if result matcher returns true ]"
                      falseValue="[ optional value to put in output field for false match ]" >

     <ResultMatcher class="[ class of com.raritantechnologies.searchApp.IResultMatcher ]" >

     </ResultMatcher>

     <!-- Optionally can specify one or two IFieldFormatter to be used for true or false formatting -->
     <FieldFormatter formatterClass="[ class of IFieldFormatter ]"
                        formatOn="[true|false - can have one of each ]" >

     </FieldFormatter>

   </FieldFormatter>
 

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

ResultMatcherFormatter()

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

ResultMatcherFormatter

public ResultMatcherFormatter()

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)

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

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.

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