com.raritantechnologies.utils.filter
Class ImportFilesStringFilter

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

All Implemented Interfaces:

IConfigurable, IStringFilter

public class ImportFilesStringFilter

extends java.lang.Object

implements IStringFilter

String Filter that can prepend and/or append to a target string. Prepend and append strings are obtained from an external file. Alternatively, the input string can be used as the file name

XML Configuration Schema:

   <StringFilter class="com.raritantechnologies.utils.filter.ImportFilesStringFilter"
                    prependFile="[name file with prepend string]"
                    appendFile="[name of file with append string]"
                    alwaysReadFile="true|false(default)"
                    inputIsFilename="true|false(default)" />
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

ImportFilesStringFilter()

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	getAppendFile()
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	getPrependFile()
java.lang.String	getPrependString()
boolean	getRefreshAlways()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setAppendFile(java.lang.String appendFile)
void	setAppendString(java.lang.String appendString)
void	setPrependFile(java.lang.String prependFile)
void	setPrependString(java.lang.String prependString)
void	setRefreshAlways(boolean refreshAlways)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportFilesStringFilter

public ImportFilesStringFilter()

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

setRefreshAlways

public void setRefreshAlways(boolean refreshAlways)

getRefreshAlways

public boolean getRefreshAlways()

setPrependString

public void setPrependString(java.lang.String prependString)

getPrependString

public java.lang.String getPrependString()

setPrependFile

public void setPrependFile(java.lang.String prependFile)

getPrependFile

public java.lang.String getPrependFile()

setAppendString

public void setAppendString(java.lang.String appendString)

getAppendString

public java.lang.String getAppendString()

setAppendFile

public void setAppendFile(java.lang.String appendFile)

getAppendFile

public java.lang.String getAppendFile()

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