com.raritantechnologies.searchApp.formatters
Class ConcatenateFormatter

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

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class ConcatenateFormatter

extends java.lang.Object

implements IFieldFormatter

Formats an IResult field by prepending and/or appending a fixed string to the target result field string.

XML Configuration Template:

    <Formatter 
        formatterClass="com.raritantechnologies.searchApp.formatters.ConcatenateFormatter" 
        fieldID="[result fieldName]" 
        prependString="[ string to prepend to target field ]" 
        appendString="[ string to append to target field ]" />
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

ConcatenateFormatter()

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	getAppendString()
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	getPrependString()
void	initialize(org.w3c.dom.Element elem) Initializes the formatter from configuration XML element.
void	setAppendString(java.lang.String appendString)
void	setFieldID(java.lang.String fieldID)
void	setPrependString(java.lang.String prependString)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcatenateFormatter

public ConcatenateFormatter()

Method Detail

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

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.

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

setFieldID

public void setFieldID(java.lang.String fieldID)

getFieldID

public java.lang.String getFieldID()

setPrependString

public void setPrependString(java.lang.String prependString)

getPrependString

public java.lang.String getPrependString()

setAppendString

public void setAppendString(java.lang.String appendString)

getAppendString

public java.lang.String getAppendString()

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