com.raritantechnologies.xml.sax.filter.callbacks
Class StringFilterCallbackOperation

java.lang.Object
  extended bycom.raritantechnologies.xml.sax.filter.callbacks.StringFilterCallbackOperation
All Implemented Interfaces:
ICallbackOperation, IConfigurable

public class StringFilterCallbackOperation
extends java.lang.Object
implements ICallbackOperation

Adds an IStringFilter operation before passing data on to target object using a nested ICallbackOperation object. Used with ProgrammableSAXFilter.

XML Configuration Template:
   <CallbackOperation class="com.raritantechnologies.xml.sax.filter.callbacks.StringFilterCallbackOperation" >
     <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter" >
       <!-- configuration parameters for string filter -->
     </StringFilter>

     <!-- nested ICallbackOperation that will handle the initial ProgrammableSAXFilter callback -->
     <CallbackOperation class="[ class of com.raritantechnologies.xml.sax.filter.callbacks.ICallbackOperation" >

     </CallbackOperation>

   </CallbackOperation>
 

Developed by Raritan Technologies .

Author:
Ted Sullivan

Field Summary
 
Fields inherited from interface com.raritantechnologies.xml.sax.filter.callbacks.ICallbackOperation
MAP, TAGXML, TEXT
 
Constructor Summary
StringFilterCallbackOperation()
           
 
Method Summary
 void doFilter(java.lang.String paramValue)
           
 void doFilter(java.lang.String field, java.lang.String paramValue)
           
 java.lang.String getLastCallbackPath()
           
 java.lang.String getParameterName()
           
 java.lang.String getType()
           
 void initialize(org.w3c.dom.Element compElem)
          Initializes the object from an XML tag or element.
 boolean isMultiple()
           
 boolean isUnique()
           
 void setCallback(ProgrammableSAXFilter psf, java.lang.Object targetObject, java.lang.String methodName)
          Sets up the callback from the ProgrammableSAXFilter to the targetObject.
 void setIsMultiple(boolean isMultiple)
          Determines whether the callback can occur more than once.
 void setIsUnique(boolean isUnique)
          Determines whether new values should appendTo or set the target value.
 void setParameterName(java.lang.String paramName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringFilterCallbackOperation

public StringFilterCallbackOperation()
Method Detail

setParameterName

public void setParameterName(java.lang.String paramName)
Specified by:
setParameterName in interface ICallbackOperation

getParameterName

public java.lang.String getParameterName()
Specified by:
getParameterName in interface ICallbackOperation

getType

public java.lang.String getType()
Specified by:
getType in interface ICallbackOperation

getLastCallbackPath

public java.lang.String getLastCallbackPath()
Specified by:
getLastCallbackPath in interface ICallbackOperation

setIsMultiple

public void setIsMultiple(boolean isMultiple)
Description copied from interface: ICallbackOperation
Determines whether the callback can occur more than once.

Specified by:
setIsMultiple in interface ICallbackOperation

isMultiple

public boolean isMultiple()
Specified by:
isMultiple in interface ICallbackOperation

setIsUnique

public void setIsUnique(boolean isUnique)
Description copied from interface: ICallbackOperation
Determines whether new values should appendTo or set the target value.

Specified by:
setIsUnique in interface ICallbackOperation

isUnique

public boolean isUnique()
Specified by:
isUnique in interface ICallbackOperation

setCallback

public void setCallback(ProgrammableSAXFilter psf,
                        java.lang.Object targetObject,
                        java.lang.String methodName)
Description copied from interface: ICallbackOperation
Sets up the callback from the ProgrammableSAXFilter to the targetObject.

Specified by:
setCallback in interface ICallbackOperation

doFilter

public void doFilter(java.lang.String field,
                     java.lang.String paramValue)

doFilter

public void doFilter(java.lang.String paramValue)

initialize

public void initialize(org.w3c.dom.Element compElem)
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 ICallbackOperation