com.raritantechnologies.searchApp.formatters
Class RemoveFieldValuesFormatter

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

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class RemoveFieldValuesFormatter

extends java.lang.Object

implements IFieldFormatter

Removes one or more values from an IResult field. The values to be removed can be fixed or can be determined by the use of one or more IComparator objects.

XML Configuration Template:

   <Formatter 
      fieldID="[  name of the field ]" 
      formatterClass="com.raritantechnologies.searchApp.formatters.RemoveFieldValuesFormatter"
      removeInnerValues="[ true|false(default) - if true removes substrings matching the given values ]" >

     <Values>
       <Value>[ the value ]</Value>
       <Value value="[ value of fixed value to remove ]" />
       <Value field="[ name of field to get value to remove from target field ]" />

       <!-- Field Values can use IComparator for comparisons: -->
       <Value field="[ name of field to get value to remove from target field ]" >
         <Comparator class="[ class of com.raritantechnologies.utils.comparators.IComparator ]" >

         </Comparator>
       </Value>

       <Value>
         <Comparator class="[ class of com.raritantechnologies.utils.comparators.IComparator ]" >

         </Comparator>
       </Value>
     </Values>

   <Formatter>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

RemoveFieldValuesFormatter()

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	getFieldID()
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.
void	setFieldID(java.lang.String fieldID)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoveFieldValuesFormatter

public RemoveFieldValuesFormatter()

Method Detail

formatResultField

public void formatResultField(IResult res)

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

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)

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)

Initializes the formatter from configuration XML element.

Specified by:

initialize in interface IFieldFormatter

setFieldID

public void setFieldID(java.lang.String fieldID)

getFieldID

public java.lang.String getFieldID()

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