com.raritantechnologies.utils.filter
Class ValueMapFilter

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

All Implemented Interfaces:

IConfigurable, IStringFilter

public class ValueMapFilter

extends java.lang.Object

implements IStringFilter

StringFilter implementation that uses a java.util.Map to replace an entire input string with a mapped replacement.

XML Configuration Template:

   <StringFilter class="com.raritantechnologies.utils.filter.ValueMapFilter"
       defaultValue="" >
       <ValueMap input="[an input string]" output="[an output string]" />
       <ValueMap input="[another input]"   output="[another output]" />
       <ValueMap input="[a third input]"   output="[a third output]" caseSensitive="false" />
   </StringFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.utils.filter.IStringFilter

TEMPLATE

Constructor Summary

ValueMapFilter()

Method Summary

void	addValueMap(java.lang.String mapFrom, java.lang.String mapTo, boolean caseSensitive)
java.lang.String	filterString(java.util.Map parameters, java.lang.String inputString)
java.lang.String	filterString(java.lang.String inputString)
java.lang.String	filterString(java.lang.String sessionID, java.lang.String inputString)
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
void	getConfigurationXML(java.io.Writer writer)
java.lang.String	getDefaultString()
boolean	getUseDefaultString()
java.util.Map	getValueMap()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setDefaultString(java.lang.String defaultString)
void	setUseDefaultString(boolean useDefaultString)

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueMapFilter

public ValueMapFilter()

Method Detail

filterString

public java.lang.String filterString(java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.util.Map parameters,
                                     java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.lang.String sessionID,
                                     java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

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

setUseDefaultString

public void setUseDefaultString(boolean useDefaultString)

getUseDefaultString

public boolean getUseDefaultString()

setDefaultString

public void setDefaultString(java.lang.String defaultString)

getDefaultString

public java.lang.String getDefaultString()

addValueMap

public void addValueMap(java.lang.String mapFrom,
                        java.lang.String mapTo,
                        boolean caseSensitive)

getValueMap

public java.util.Map getValueMap()

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IStringFilter

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)

Specified by:

getConfigurationXML in interface IStringFilter