com.raritantechnologies.utils.filter
Class DelimitedFieldMapFilter

java.lang.Object
  com.raritantechnologies.utils.filter.DelimitedFieldMapFilter

All Implemented Interfaces:

IConfigurable, IMapFilter

public class DelimitedFieldMapFilter

extends java.lang.Object

implements IMapFilter

Implementation of IMapFilter that splits a java.util.Map field value on a delimiter and creates new sequentially numbered map fields from the delimited values.

XML Configuration Template:

   <MapFilter class="com.raritantechnologies.utils.filter.DelimitedFieldMapFilter"
                 fieldID="[map field to split]"
                 delimiter="[delimiter to split on]" >

    <!-- optional StringFilter that will be applied to each delimited value -->
    <StringFilter class="[class of com.raritantechnologies.utils.filter.IStringFilter]" >
       <!-- configuration parameters for string filter -->
    </StringFilter>

   </MapFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

DelimitedFieldMapFilter()

Method Summary

java.util.Map	filterMap(java.util.Map theMap) return a filtered version of a java.util.Map object.
java.lang.String	getConfigurationXML()
java.lang.String	getDelimitedField()
java.lang.String	getDelimiter()
IStringFilter	getStringFilter()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setDelimitedField(java.lang.String delimitedField)
void	setDelimiter(java.lang.String delimiter)
void	setStringFilter(IStringFilter stringFilter)

Methods inherited from class java.lang.Object

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

Constructor Detail

DelimitedFieldMapFilter

public DelimitedFieldMapFilter()

Method Detail

initialize

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

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

filterMap

public java.util.Map filterMap(java.util.Map theMap)

Description copied from interface: IMapFilter

return a filtered version of a java.util.Map object.

Specified by:

filterMap in interface IMapFilter

setDelimitedField

public void setDelimitedField(java.lang.String delimitedField)

getDelimitedField

public java.lang.String getDelimitedField()

setDelimiter

public void setDelimiter(java.lang.String delimiter)

getDelimiter

public java.lang.String getDelimiter()

setStringFilter

public void setStringFilter(IStringFilter stringFilter)

getStringFilter

public IStringFilter getStringFilter()

getConfigurationXML

public java.lang.String getConfigurationXML()