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

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

All Implemented Interfaces:

ICallbackOperation, IConfigurable

public class TagTextCallbackOperation

extends java.lang.Object

implements ICallbackOperation

Callback operation that uses a TagTextExtractor to extract XML text from a tag and pass that text to a target object via the callback method.

XML Configuration Template:

  <CallbackOperation class="com.raritantechnologies.xml.sax.filter.callbacks.TagTextCallbackOperation"
                        includeChildText="true|false" >
    <ParamName>[ callback parameter value for two parameter methods ]</ParamName>

    <!-- Comparator determines which XML Tags to select for text extraction -->
    <Comparator class="[ class of ElementComparator ]" >

    </Comparator>

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

TagTextCallbackOperation()

TagTextCallbackOperation(ElementComparator comp, boolean includeChildText)

TagTextCallbackOperation(java.lang.String paramName, ElementComparator comp, boolean includeChildText)

Method Summary

ElementComparator	getElementComparator()
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) the parameter name of the callback method (if any )

Methods inherited from class java.lang.Object

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

Constructor Detail

TagTextCallbackOperation

public TagTextCallbackOperation()

TagTextCallbackOperation

public TagTextCallbackOperation(ElementComparator comp,
                                boolean includeChildText)

TagTextCallbackOperation

public TagTextCallbackOperation(java.lang.String paramName,
                                ElementComparator comp,
                                boolean includeChildText)

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)

the parameter name of the callback method (if any )

Specified by:

setParameterName in interface ICallbackOperation

getParameterName

public java.lang.String getParameterName()

Specified by:

getParameterName in interface ICallbackOperation

getElementComparator

public ElementComparator getElementComparator()

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

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