com.raritantechnologies.utils.filter
Class SequentialStringFilter

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

All Implemented Interfaces:

IConfigurable, IStringFilter

public class SequentialStringFilter

extends java.lang.Object

implements IStringFilter

Applies one or more StringFilter operations in sequence using a set of nested StringFilters.

XML Configuration Template:

   <StringFilter class="com.raritantechnologies.utils.filter.SequentialStringFilter" >

     <!-- First nested StringFilter in the sequence... -->
     <StringFilter class="[class of com.raritantechnologies.utils.filter.IStringFilter" >
        <!-- configuration parameters required by this type of IStringFilter -->
     </StringFilter>

     <!-- Second nested StringFilter in the sequence... -->
     <StringFilter class="[class of com.raritantechnologies.utils.filter.IStringFilter" >
        <!-- configuration parameters required by this type of IStringFilter -->
     </StringFilter>

     <!-- more filters ... -->
   </StringFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

SequentialStringFilter()

Method Summary

void	addStringFilter(IStringFilter filter)
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.util.Map parameters, 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)
IStringFilter[]	getStringFilters()
void	initialize(org.w3c.dom.Element initElem) Initializes the object from an XML tag or element.
void	setStringFilters(IStringFilter[] filters)

Methods inherited from class java.lang.Object

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

Constructor Detail

SequentialStringFilter

public SequentialStringFilter()

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.lang.String sessionID,
                                     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.util.Map parameters,
                                     java.lang.String inputString)

initialize

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

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

setStringFilters

public void setStringFilters(IStringFilter[] filters)

getStringFilters

public IStringFilter[] getStringFilters()

addStringFilter

public void addStringFilter(IStringFilter filter)

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