com.raritantechnologies.utils.filter
Class RegExprStringFilter

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

All Implemented Interfaces:

IConfigurable, IStringFilter

public class RegExprStringFilter

extends java.lang.Object

implements IStringFilter

Filters a string by applying a regular expression match / replace to the input string.

XML Configuration Template:

   <StringFilter class="com.raritantechnologies.utils.filter.RegExprStringFilter"
                    inPattern="[regular expression input pattern]"
                    outPattern="[regular expression substitution pattern]"
                    substituteAll="true|false(default)"
                    returnInputIfFail="true(default)|false" >

     <!-- can define more than one regular expression, the first pattern that matches will be applied -->
     <Pattern inPattern="[regular expression input pattern]"
                 outPattern="[regular expression substitution pattern]" />
   
     <Pattern inPattern="[another regular expression input pattern]"
                 outPattern="[regular expression substitution pattern]" />

     <!-- etc... -->

   </StringFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

RegExprStringFilter()

RegExprStringFilter(java.lang.String[] inPatterns, java.lang.String[] outPatterns)

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

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[]	getInPatterns()
java.lang.String[]	getOutPatterns()
boolean	getUseSubstituteAll()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setRegExprPatterns(java.lang.String[] inPatterns, java.lang.String[] outPatterns)
void	setRegExprPatterns(java.lang.String inPattern, java.lang.String outPattern)
void	setUseSubstituteAll(boolean useSubstituteAll)

Methods inherited from class java.lang.Object

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

Constructor Detail

RegExprStringFilter

public RegExprStringFilter()

RegExprStringFilter

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

RegExprStringFilter

public RegExprStringFilter(java.lang.String[] inPatterns,
                           java.lang.String[] outPatterns)

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

setRegExprPatterns

public void setRegExprPatterns(java.lang.String inPattern,
                               java.lang.String outPattern)

setRegExprPatterns

public void setRegExprPatterns(java.lang.String[] inPatterns,
                               java.lang.String[] outPatterns)

getInPatterns

public java.lang.String[] getInPatterns()

getOutPatterns

public java.lang.String[] getOutPatterns()

setUseSubstituteAll

public void setUseSubstituteAll(boolean useSubstituteAll)

getUseSubstituteAll

public boolean getUseSubstituteAll()

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