com.raritantechnologies.utils.filter
Class ConcatenateFilter

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

All Implemented Interfaces:

IConfigurable, IStringFilter

public class ConcatenateFilter

extends java.lang.Object

implements IStringFilter

Can prepend and or append a fixed string to the input string. Can be used to 'normalize' string beginnings and/or endings using 'dontDuplicate' attribute.

XML Configuration Template:

   <StringFilter class="com.raritantechnologies.utils.filter.ConcatenateFilter"
                    prependString="[string to prepend to target string]"
                    appendString="[string to append to target string]"
                    dontDuplicate="[ true|false(default): if true - only prepend or append if string does not start or end with value " >

     <!-- Optionally, can use a StringFilter to get prepend or append strings -->
     <PrependFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

     </PrependFilter>

     </AppendFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

     </AppendFilter>

     <!-- Can also specify prepend and/or append string in tag text - useful if the text is fairly long or structured -->
     <PrependString>
       <![CData[ The string ]]>
     </PrependString>

     <AppendString>
       <![CData[ The string ]]>   
     <AppendString>

   </StringFilter>

 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

ConcatenateFilter()

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	getAppendString()
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
void	getConfigurationXML(java.io.Writer writer)
java.lang.String	getPrependString()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setAppendString(java.lang.String appendString)
void	setPrependString(java.lang.String prependString)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcatenateFilter

public ConcatenateFilter()

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

setPrependString

public void setPrependString(java.lang.String prependString)

getPrependString

public java.lang.String getPrependString()

setAppendString

public void setAppendString(java.lang.String appendString)

getAppendString

public java.lang.String getAppendString()

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