com.raritantechnologies.searchApp.formatters
Class DateFieldFormatter

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

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class DateFieldFormatter

extends java.lang.Object

implements IFieldFormatter

Formats an IResult date field using a java.text.DateFormat object.

XML Configuration Template:

    <Formatter 
        formatterClass="com.raritantechnologies.searchApp.formatters.DateFieldFormatter" 
        fieldID="fieldName" 
        inputFormat="EEE, MMM d, yyyy" 
        outputFormat="MM/dd/yy" >
      <InputFormat>dd-MMM-yy</InputFormat>
      <InputFormat>dd/MM/yy hh:mm:ss</InputFormat>
    </Formatter>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

DateFieldFormatter()

DateFieldFormatter(java.lang.String fieldName, java.lang.String inputFormat, java.lang.String outputFormat)

Method Summary

void	addTimeStamp(IResult toResult)
java.lang.String	formatDate(java.util.Date theDate)
static java.lang.String	formatDate(java.lang.String dateFormat, java.util.Date theDate)
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	getInputFormat()
java.lang.String	getOutputFormat()
void	initialize(org.w3c.dom.Element initElem) Initializes the formatter from configuration XML element.
java.util.Date	parseDate(IResult result)
java.util.Date	parseDate(java.lang.String fieldVal)
void	setFieldID(java.lang.String fieldID)
void	setInputFormat(java.lang.String inputFormat)
void	setOutputFormat(java.lang.String outputFormat)

Methods inherited from class java.lang.Object

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

Constructor Detail

DateFieldFormatter

public DateFieldFormatter()

DateFieldFormatter

public DateFieldFormatter(java.lang.String fieldName,
                          java.lang.String inputFormat,
                          java.lang.String outputFormat)

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.

formatDate

public static java.lang.String formatDate(java.lang.String dateFormat,
                                          java.util.Date theDate)

formatDate

public java.lang.String formatDate(java.util.Date theDate)

addTimeStamp

public void addTimeStamp(IResult toResult)

parseDate

public java.util.Date parseDate(IResult result)

parseDate

public java.util.Date parseDate(java.lang.String fieldVal)

initialize

public void initialize(org.w3c.dom.Element initElem)

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

setInputFormat

public void setInputFormat(java.lang.String inputFormat)

getInputFormat

public java.lang.String getInputFormat()

setOutputFormat

public void setOutputFormat(java.lang.String outputFormat)

getOutputFormat

public java.lang.String getOutputFormat()

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