http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

Y2K Compliance
PDF Document

CVS Repository
Mail Archive

API Docs for SAX and DOM
 

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

IDOM_Attr Class Reference

The IDOM_Attr class refers to an attribute of an XML element. More...

#include <IDOM_Attr.hpp>

Inheritance diagram for IDOM_Attr

Inheritance graph
[legend]
Collaboration diagram for IDOM_Attr:

Collaboration graph
[legend]
List of all members.

Public Methods

Destructor
virtual ~IDOM_Attr ()
 Destructor. More...

Getter functions
virtual const XMLCh* getName ()const=0
 Returns the name of this attribute.

virtual bool getSpecified ()const=0
 Returns true if the attribute received its value explicitly in the XML document, or if a value was assigned programatically with the setValue function. More...

virtual const XMLCh* getValue ()const=0
 Returns the value of the attribute. More...

Setter functions
virtual void setValue (const XMLCh *value)=0
 Sets the value of the attribute. More...

Functions introduced in DOM Level 2.
virtual IDOM_ElementgetOwnerElement ()const=0
 The DOM_Element node this attribute is attached to or null if this attribute is not in use.


Protected Methods

 IDOM_Attr ()
 IDOM_Attr (const IDOM_Attr &other)
IDOM_Attr& operator= (const IDOM_Attr &other)

Detailed Description

The IDOM_Attr class refers to an attribute of an XML element.

Typically the allowable values for the attribute are defined in a documenttype definition.

IDOM_Attr objects inherit the DOM_Node interface, but since attributes are not actually child nodes of the elements they are associated with, the DOM does not consider them part of the document tree. Thus, the DOM_Node attributes parentNode, previousSibling, and nextSibling have a null value for IDOM_Attr objects. The DOM takes the view that attributes are properties of elements rather than having a separate identity from the elements they are associated with; this should make it more efficient to implement such features as default attributes associated with all elements of a given type. Furthermore, attribute nodes may not be immediate children of a DocumentFragment. However, they can be associated with Element nodes contained within a DocumentFragment. In short, users of the DOM need to be aware that Attr nodes have some things in common with other objects inheriting the Node interface, but they also are quite distinct.


Constructor & Destructor Documentation

IDOM_Attr::IDOM_Attr ( ) [protected]
 

IDOM_Attr::IDOM_Attr ( const IDOM_Attr & other ) [protected]
 

IDOM_Attr::~IDOM_Attr ( ) [virtual]
 

Destructor.

The object being destroyed is a reference to the Attribute "node", not the underlying attribute itself.


Member Function Documentation

const XMLCh * IDOM_Attr::getName ( ) const [pure virtual]
 

Returns the name of this attribute.

IDOM_Element * IDOM_Attr::getOwnerElement ( ) const [pure virtual]
 

The DOM_Element node this attribute is attached to or null if this attribute is not in use.

bool IDOM_Attr::getSpecified ( ) const [pure virtual]
 

Returns true if the attribute received its value explicitly in the XML document, or if a value was assigned programatically with the setValue function.

Returns false if the attribute value came from the default value declared in the document's DTD.

const XMLCh * IDOM_Attr::getValue ( ) const [pure virtual]
 

Returns the value of the attribute.

The value of the attribute is returned as a string. Character and general entity references are replaced with their values.

IDOM_Attr & IDOM_Attr::operator= ( const IDOM_Attr & other ) [protected]
 

void IDOM_Attr::setValue ( const XMLCh * value ) [pure virtual]
 

Sets the value of the attribute.

A text node with the unparsed contents of the string will be created.

Parameters:
value   The value of the DOM attribute to be set


The documentation for this class was generated from the following file:


Copyright © 2000 The Apache Software Foundation. All Rights Reserved.