com.raritantechnologies.utils.filter
Class LookupStringFilter

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

All Implemented Interfaces:

IConfigurable, IStringFilter

public class LookupStringFilter

extends java.lang.Object

implements IStringFilter

StringFilter that uses an RTI SearchSource to lookup a value from the input string.

XML Configuration Template:

   <StringFilter class="com.raritantechnologies.utils.filter.LookupStringFilter"
                    searchSource="[name of RTI search source]"
                    queryField="[name of query field in search source]"
                    outputField="[name of result field in search result to use as output]"
                    returnOnNull="EMPTY|INPUT|FILTER_INPUT" >

       <!-- Optional Input filter to filter input string before querying the source -->
       <InputFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter]" >
          <!-- initialization parameters for input filter -->
       </InputFilter>

       <!-- Optional proxy filter to filter the output result -->
       <OutputFilter class="[class of com.raritantechnologies.utils.filter.IStringFilter]" >
          <!-- initialization parameters for proxy filter -->
       </OutputFilter>

  </StringFilter>
 

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

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

TEMPLATE

Constructor Summary

LookupStringFilter()

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.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)
java.lang.String	getOutputField()
IStringFilter	getProxyFilter()
java.lang.String	getQueryField(java.lang.String queryField)
java.lang.String	getSearchSource()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setOutputField(java.lang.String outputField)
void	setProxyFilter(IStringFilter proxyFilter)
void	setQueryField(java.lang.String queryField)
void	setSearchSource(java.lang.String searchSourceName)

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupStringFilter

public LookupStringFilter()

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 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

setSearchSource

public void setSearchSource(java.lang.String searchSourceName)

getSearchSource

public java.lang.String getSearchSource()

setQueryField

public void setQueryField(java.lang.String queryField)

getQueryField

public java.lang.String getQueryField(java.lang.String queryField)

setOutputField

public void setOutputField(java.lang.String outputField)

getOutputField

public java.lang.String getOutputField()

setProxyFilter

public void setProxyFilter(IStringFilter proxyFilter)

getProxyFilter

public IStringFilter getProxyFilter()

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