com.raritantechnologies.utils.filter
Class ReplaceSubstringFilter

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

All Implemented Interfaces:

IConfigurable, IStringFilter

public class ReplaceSubstringFilter

extends java.lang.Object

implements IStringFilter

Configurable String Filter that replaces a substring token in the target string.

XML Configuration Template:

   <StringFilter class="com.raritantechnologies.utils.filter.ReplaceSubstringFilter"
                    inPattern="aPat"
                    outPattern="replacePat"
                    replace="ALL|FIRST|LAST" />
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

static java.lang.String	ALL
static java.lang.String	FIRST
static java.lang.String	LAST

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

TEMPLATE

Constructor Summary

ReplaceSubstringFilter()

ReplaceSubstringFilter(java.lang.String inPattern, java.lang.String outPattern)

ReplaceSubstringFilter(java.lang.String inPattern, java.lang.String outPattern, java.lang.String replace)

Method Summary

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	getInPattern()
java.lang.String	getOutPattern()
java.lang.String	getReplace()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setInPattern(java.lang.String inPattern)
void	setOutPattern(java.lang.String outPattern)
void	setReplace(java.lang.String replace)

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final java.lang.String ALL

See Also:

Constant Field Values

FIRST

public static final java.lang.String FIRST

See Also:

Constant Field Values

LAST

public static final java.lang.String LAST

See Also:

Constant Field Values

Constructor Detail

ReplaceSubstringFilter

public ReplaceSubstringFilter()

ReplaceSubstringFilter

public ReplaceSubstringFilter(java.lang.String inPattern,
                              java.lang.String outPattern)

ReplaceSubstringFilter

public ReplaceSubstringFilter(java.lang.String inPattern,
                              java.lang.String outPattern,
                              java.lang.String replace)

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

setInPattern

public void setInPattern(java.lang.String inPattern)

getInPattern

public java.lang.String getInPattern()

setOutPattern

public void setOutPattern(java.lang.String outPattern)

getOutPattern

public java.lang.String getOutPattern()

setReplace

public void setReplace(java.lang.String replace)

getReplace

public java.lang.String getReplace()

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