com.raritantechnologies.searchApp.formatters
Class MultiValueDeduper

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

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class MultiValueDeduper

extends java.lang.Object

implements IFieldFormatter

De duplicates values in a multiple value IResult field. Can include an IStringFilter to normalize input values prior to de-duping.

XML Configuration Template:

   <Formatter 
      formatterClass="com.raritantechnologies.searchApp.formatters.MultiValueDeduper"
      inputFieldID="input field Name" 
      outputFieldID="output field name"\
      fieldDelimiter="delimiter (if isDelimitedValue is true) [default is comma]"\
      isDelimitedValue="true|false(default)">
			<!-- determines if field is mulivalue or single, delimited value -->

    <!-- Optional String Filter that is applied to input value tokens. -->
    <StringFilter class="some com.raritantechnologies.utils.filter.IStringFilter class" >
       <!-- configuration parameters for string filter -->
    </StringFilter>

   </Formatter>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter

TEMPLATE

Constructor Summary

MultiValueDeduper()

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) Tokenizes the results input fields, optionally filters each value and adds the tokens to the output field as multiple values.
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	getFieldName() Returns the name of the result field that this formatter can reformat.
java.lang.String	getInputFieldID()
IStringFilter	getStringFilter()
java.lang.String	gsetOutputFieldID()
void	initialize(org.w3c.dom.Element elem) Initializes the formatter from configuration XML element.
void	setInputFieldID(java.lang.String inputFieldID)
void	setOutputFieldID(java.lang.String outputFieldID)
void	setStringFilter(IStringFilter stringFilter)

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiValueDeduper

public MultiValueDeduper()

Method Detail

formatResultField

public void formatResultField(IResult res)

Tokenizes the results input fields, optionally filters each value and adds the tokens to the output field as multiple values.

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

setOutputFieldID

public void setOutputFieldID(java.lang.String outputFieldID)

gsetOutputFieldID

public java.lang.String gsetOutputFieldID()

setInputFieldID

public void setInputFieldID(java.lang.String inputFieldID)

getInputFieldID

public java.lang.String getInputFieldID()

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