xmltooling::AttributeExtensibleXMLObject Class Reference

An XMLObject that supports arbitrary attributes. More...

#include <xmltooling/AttributeExtensibleXMLObject.h>

Inheritance diagram for xmltooling::AttributeExtensibleXMLObject:

xmltooling::XMLObject soap11::Envelope xmltooling::AbstractAttributeExtensibleXMLObject xmltooling::ElementProxy soap11::Body soap11::Detail soap11::Header xmlencryption::EncryptionProperty List of all members.

Public Member Functions

virtual const XMLCh * getAttribute (const QName &qualifiedName) const =0
 Gets the value of an XML attribute of the object.
virtual void setAttribute (const QName &qualifiedName, const XMLCh *value, bool ID=false)=0
 Sets (or clears) an XML attribute of the object.
virtual const std::map< QName,
XMLCh * > & 
getExtensionAttributes () const =0
 Gets an immutable map of the extended XML attributes of the object.

Static Public Member Functions

static const std::set< QName > & getRegisteredIDAttributes ()
 Gets an immutable list of all the ID attributes currently registered.
static bool isRegisteredIDAttribute (const QName &name)
 Tests whether an XML attribute is registered as an XML ID.
static void registerIDAttribute (const QName &name)
 Registers a new attribute as being of XML ID type.
static void deregisterIDAttribute (const QName &name)
 Deregisters an ID attribute.
static void deregisterIDAttributes ()
 Deregisters all ID attributes.

Detailed Description

An XMLObject that supports arbitrary attributes.


Member Function Documentation

static void xmltooling::AttributeExtensibleXMLObject::deregisterIDAttribute ( const QName name  )  [inline, static]

Deregisters an ID attribute.

Parameters:
name the qualified attribute name

virtual const XMLCh* xmltooling::AttributeExtensibleXMLObject::getAttribute ( const QName qualifiedName  )  const [pure virtual]

Gets the value of an XML attribute of the object.

Parameters:
qualifiedName qualified name of the attribute
Returns:
the attribute value, or NULL

Implemented in xmltooling::AbstractAttributeExtensibleXMLObject.

virtual const std::map<QName,XMLCh*>& xmltooling::AttributeExtensibleXMLObject::getExtensionAttributes (  )  const [pure virtual]

Gets an immutable map of the extended XML attributes of the object.

This set is not guaranteed to (and generally will not) include attributes defined directly on the object's "type".

Implemented in xmltooling::AbstractAttributeExtensibleXMLObject.

static const std::set<QName>& xmltooling::AttributeExtensibleXMLObject::getRegisteredIDAttributes (  )  [inline, static]

Gets an immutable list of all the ID attributes currently registered.

Returns:
list of all the ID attributes currently registered

static bool xmltooling::AttributeExtensibleXMLObject::isRegisteredIDAttribute ( const QName name  )  [inline, static]

Tests whether an XML attribute is registered as an XML ID.

Returns:
true iff the attribute name matches a registered XML ID attribute

static void xmltooling::AttributeExtensibleXMLObject::registerIDAttribute ( const QName name  )  [inline, static]

Registers a new attribute as being of XML ID type.

Parameters:
name the qualified attribute name

virtual void xmltooling::AttributeExtensibleXMLObject::setAttribute ( const QName qualifiedName,
const XMLCh *  value,
bool  ID = false 
) [pure virtual]

Sets (or clears) an XML attribute of the object.

Parameters:
qualifiedName qualified name of the attribute
value value to set, or NULL to clear
ID true iff the attribute is an XML ID

Implemented in xmltooling::AbstractAttributeExtensibleXMLObject.


The documentation for this class was generated from the following file:
Generated on Mon Oct 19 14:18:34 2009 for xmltooling by  doxygen 1.4.7