com.raritantechnologies.searchApp.formatters
Class StringFilterFormatter

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

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class StringFilterFormatter

extends java.lang.Object

implements IFieldFormatter

Applies some string filtering operation to an IResult field using an IStringFilter.

XML Configuration Template:

   <Formatter 
      fieldID="[ input fieldName ]" 
      outputID="[optional field name for filtered value]" 
      formatterClass="com.raritantechnologies.searchApp.formatters.StringFilterFormatter"
      trimOutput="[ true(default)|false ]"
      appendMode="[ true|false(default) ]"
      appendDelimiter="[ delimiter to use for append mode ]"
      multiple="[ true|false(default) - true if input field has multiple values. ]"
      createMultiple="[ true|false(default) - if true, create multiple fields from Filter output ]
      createDelimiter="[ delimiter to use for multiple value extraction (default=',') ]"  >

     <StringFilter class="[class of com.raritantechnologies.utils.filter.IStringFilter]" >
        <!-- details of IStringFilter implementation -->
     </StringFilter>

   </Formatter>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

StringFilterFormatter()

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.
java.lang.String	getOutputID()
IStringFilter	getStringFilter()
void	initialize(org.w3c.dom.Element elem) Initializes the formatter from configuration XML element.
void	setFieldID(java.lang.String fieldID)
void	setOutputID(java.lang.String outputID)
void	setStringFilter(IStringFilter stringFilter)

Methods inherited from class java.lang.Object

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

Constructor Detail

StringFilterFormatter

public StringFilterFormatter()

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

setOutputID

public void setOutputID(java.lang.String outputID)

getOutputID

public java.lang.String getOutputID()

setStringFilter

public void setStringFilter(IStringFilter stringFilter)

getStringFilter

public IStringFilter getStringFilter()

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