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

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

All Implemented Interfaces:

ICallbackOperation, IConfigurable

public class FieldValueCallbackOperation

extends java.lang.Object

implements ICallbackOperation

Callback Operation used to handle dynamic data objects where the name and value of the attribute are defined in separate XML tags. For example:

   <Field>
     <Name>[ contains the name of the field or attribute ]</Name>
     <Value>[ contains the value of the field or attribute ]</Value>
   </Field>
 

XML Configuration Template:

   <CallbackOperation class="com.raritantechnologies.xml.sax.filter.callbacks.FieldValueCallbackOperation"
                         fieldTag="[ Tag name that contains field name/value pairs ]"
                         nameTag="[ Tag name that contains the field name ]"
                         valueTag="[ Tag name that contains the field value ]" />
 

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

FieldValueCallbackOperation()

FieldValueCallbackOperation(java.lang.String fieldTagName, java.lang.String nameTagName, java.lang.String valueTagName)

Method Summary

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

FieldValueCallbackOperation

public FieldValueCallbackOperation()

FieldValueCallbackOperation

public FieldValueCallbackOperation(java.lang.String fieldTagName,
                                   java.lang.String nameTagName,
                                   java.lang.String valueTagName)

Method Detail

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

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

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

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)

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)

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