com.raritantechnologies.clearforest
Class ClearForestStringFilter

java.lang.Object
  extended bycom.raritantechnologies.clearforest.ClearForestStringFilter
All Implemented Interfaces:
IConfigurable, IStringFilter

public class ClearForestStringFilter
extends java.lang.Object
implements IStringFilter

Applies ClearForest tagging to a character string. Submits the string for tagging to the ClearForest server via a SOAP connection.

XML Configuration Template:
  <StringFilter class="com.raritantechnologies.clearforest.ClearForestStringFilter"
                   clearForestServer="[ URL of ClearForest web service ]"
                   profileName="[ ClearForest tagging module name ]" />
 

Developed by Raritan Technologies .

Author:
Ted Sullivan

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

Constructor Detail

ClearForestStringFilter

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

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