com.raritantechnologies.utils.filter
Class SelectingStringFilter

java.lang.Object
  extended bycom.raritantechnologies.utils.filter.SelectingStringFilter
All Implemented Interfaces:
IConfigurable, IStringFilter

public class SelectingStringFilter
extends java.lang.Object
implements IStringFilter

Applies StringFilter operation IFF the contained IComparator matches the target string.

XML Configuration Template:
   <StringFilter class="com.raritantechnologies.utils.filter.SelectingStringFilter" >

     <Comparator class="[some com.raritantechnologies.utils.comparators.IComparator class]" >
        <!-- configuration parameters for comparator -->
     </Comparator>

     <StringFilter class="[some com.raritantechnologies.utils.filter.IStringFilter class]" >
        <!-- configuration parameters for string filter -->
     </StringFilter>

   </StringFilter>
 

Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
 
Fields inherited from interface com.raritantechnologies.utils.filter.IStringFilter
TEMPLATE
 
Constructor Summary
SelectingStringFilter()
           
 
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)
           
 IStringFilter getProxyFilter()
           
 IComparator getSelector(IComparator selector)
           
 void initialize(org.w3c.dom.Element elem)
          Initializes the object from an XML tag or element.
 void setProxyFilter(IStringFilter proxyFilter)
           
 void setSelector(IComparator selector)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SelectingStringFilter

public SelectingStringFilter()
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

setProxyFilter

public void setProxyFilter(IStringFilter proxyFilter)

getProxyFilter

public IStringFilter getProxyFilter()

setSelector

public void setSelector(IComparator selector)

getSelector

public IComparator getSelector(IComparator selector)

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