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

java.lang.Object
  com.raritantechnologies.xml.sax.filter.callbacks.AttributeCallbackOperation

All Implemented Interfaces:

ICallbackOperation, IConfigurable

public class AttributeCallbackOperation

extends java.lang.Object

implements ICallbackOperation

Sets up an Callback operation which captures the value of an XML tag Attribute. Works with ProgrammableSAXFilter. Can include an optional IStringFilter to do string manipulations on attribute values before invoking the callback method.

XML Configuration Template:

  <CallbackOperation class="com.raritantechnologies.xml.sax.filter.callbacks.AttributeCallbackOperation"
                        includeChildText="true|false" >
    <AttributeName>[ name of attribute to extract ]</AttributeName>
    <ParamName>[ callback parameter value for two parameter methods ]</ParamName>

    <Comparator class="[ class of ElementComparator ]" >

    </Comparator>

    <!-- Optional String filter to modify value of attribute before invoking callback method -->
    <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

    </StringFilter>

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

AttributeCallbackOperation()

AttributeCallbackOperation(java.lang.String paramName, ElementComparator comp, java.lang.String attrName)

Method Summary

java.lang.String	getAttributeName()
ElementComparator	getElementComparator()
java.lang.String	getLastCallbackPath()
java.lang.String	getParameterName()
java.lang.String	getType()
java.lang.String	getUri()
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) Connects the callback operation to a ProgrammableSAXFilter and a target object
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

AttributeCallbackOperation

public AttributeCallbackOperation()

AttributeCallbackOperation

public AttributeCallbackOperation(java.lang.String paramName,
                                  ElementComparator comp,
                                  java.lang.String attrName)

Method Detail

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

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

getElementComparator

public ElementComparator getElementComparator()

getUri

public java.lang.String getUri()

getAttributeName

public java.lang.String getAttributeName()

setCallback

public void setCallback(ProgrammableSAXFilter psf,
                        java.lang.Object targetObject,
                        java.lang.String methodName)

Connects the callback operation to a ProgrammableSAXFilter and a target object

Specified by:

setCallback 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