Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

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

XalanElement Class Reference

#include <XalanElement.hpp>

Inheritance diagram for XalanElement:

Inheritance graph
[legend]
Collaboration diagram for XalanElement:

Collaboration graph
[legend]
List of all members.

Public Methods

Cloning function.
Functions to modify the DOM Node.
Query functions.
Set functions.
Functions introduced in DOM Level 2.
Set functions.
Functions which modify the Element.
Functions introduced in DOM Level 2.

Protected Methods

Constructor & Destructor Documentation

XalanElement::XalanElement ( )
 

XalanElement::~XalanElement ( ) [virtual]
 

XalanElement::XalanElement ( const XalanElement & theSource ) [protected]
 

Member Function Documentation

XalanNode * XalanElement::appendChild ( XalanNode * newChild ) [pure virtual]
 

Adds the node newChild to the end of the list of children of this node.

If the newChild is already in the tree, it is first removed.

Parameters:
newChild   The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node
Returns:
The node added.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanElement * XalanElement::cloneNode ( bool deep ) const [pure virtual]
 

Returns a duplicate of this node.

This function serves as a generic copy constructor for nodes.

The duplicate node has no parent ( parentNode returns null.).
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning any other type of node simply returns a copy of this node.

Parameters:
deep   If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
Returns:
The duplicate node.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XalanSourceTreeElementA, XalanSourceTreeElementANS, XalanSourceTreeElementNA, XalanSourceTreeElementNANS, XercesElementWrapper, and XercesElementBridge.

const XalanDOMString & XalanElement::getAttribute ( const XalanDOMString & name ) const [pure virtual]
 

Retrieves an attribute value by name.

Parameters:
name   The name of the attribute to retrieve.
Returns:
The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

Reimplemented in XalanSourceTreeElement, XalanSourceTreeElementA, XalanSourceTreeElementNA, XercesElementWrapper, and XercesElementBridge.

const XalanDOMString & XalanElement::getAttributeNS ( const XalanDOMString & namespaceURI,
const XalanDOMString & localName ) const [pure virtual]
 

Retrieves an attribute value by local name and namespace URI.

Parameters:
namespaceURI   The namespace URI of the attribute to retrieve.
localName   The local name of the attribute to retrieve.
Returns:
The Attr value as a string, or an empty string if that attribute does not have a specified or default value.

Reimplemented in XalanSourceTreeElement, XalanSourceTreeElementA, XalanSourceTreeElementNA, XercesElementWrapper, and XercesElementBridge.

XalanAttr * XalanElement::getAttributeNode ( const XalanDOMString & name ) const [pure virtual]
 

Retrieves an Attr node by name.

Parameters:
name   The name (nodeName) of the attribute to retrieve.
Returns:
The Attr node with the specified name (nodeName) or null if there is no such attribute.

Reimplemented in XalanSourceTreeElement, XalanSourceTreeElementA, XalanSourceTreeElementNA, XercesElementWrapper, and XercesElementBridge.

XalanAttr * XalanElement::getAttributeNodeNS ( const XalanDOMString & namespaceURI,
const XalanDOMString & localName ) const [pure virtual]
 

Retrieves an Attr node by local name and namespace URI.

Parameters:
namespaceURI   The namespace URI of the attribute to retrieve.
localName   The local name of the attribute to retrieve.
Returns:
The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

Reimplemented in XalanSourceTreeElement, XalanSourceTreeElementA, XalanSourceTreeElementNA, XercesElementWrapper, and XercesElementBridge.

const XalanNamedNodeMap * XalanElement::getAttributes ( ) const [pure virtual]
 

Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XalanSourceTreeElementA, XalanSourceTreeElementNA, XercesElementWrapper, and XercesElementBridge.

const XalanNodeList * XalanElement::getChildNodes ( ) const [pure virtual]
 

Gets a NodeList that contains all children of this node.

If there are no children, this is a NodeList containing no nodes. The content of the returned NodeList is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeList accessors; it is not a static snapshot of the content of the node. This is true for every NodeList, including the ones returned by the getElementsByTagName method.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanNodeList * XalanElement::getElementsByTagName ( const XalanDOMString & name ) const [pure virtual]
 

Returns a NodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the Element tree.

Caller is responsible for deleting the XalanNodeList instance.

Parameters:
name   The name of the tag to match on. The special value "*" matches all tags.
Returns:
A list of matching Element nodes.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanNodeList * XalanElement::getElementsByTagNameNS ( const XalanDOMString & namespaceURI,
const XalanDOMString & localName ) const [pure virtual]
 

Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the Document tree, starting from this node.

Caller is responsible for deleting the XalanNodeList instance.

Parameters:
namespaceURI   The namespace URI of the elements to match on. The special value "*" matches all namespaces.
localName   The local name of the elements to match on. The special value "*" matches all local names.
Returns:
A new NodeList object containing all the matched Elements.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanNode * XalanElement::getFirstChild ( ) const [pure virtual]
 

Gets the first child of this node.

If there is no such node, this returns null.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

IndexType XalanElement::getIndex ( ) const [pure virtual]
 

Get the node's index.

Valid only if the owner document reports that the document is node-order indexed.

Returns:
The index value, or 0 if the node is not indexed.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanNode * XalanElement::getLastChild ( ) const [pure virtual]
 

Gets the last child of this node.

If there is no such node, this returns null.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

const XalanDOMString & XalanElement::getLocalName ( ) const [pure virtual]
 

Returns the local part of the qualified name of this node.

For nodes created with a DOM Level 1 method, such as createElement from the Document interface, it is null.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XalanSourceTreeElementA, XalanSourceTreeElementANS, XalanSourceTreeElementNA, XalanSourceTreeElementNANS, XercesElementWrapper, and XercesElementBridge.

const XalanDOMString & XalanElement::getNamespaceURI ( ) const [pure virtual]
 

Get the namespace URI of this node, or null if it is unspecified.

This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.

For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XalanSourceTreeElementA, XalanSourceTreeElementANS, XalanSourceTreeElementNA, XalanSourceTreeElementNANS, XercesElementWrapper, and XercesElementBridge.

XalanNode * XalanElement::getNextSibling ( ) const [pure virtual]
 

Gets the node immediately following this node.

If there is no such node, this returns null.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

const XalanDOMString & XalanElement::getNodeName ( ) const [pure virtual]
 

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

NodeType XalanElement::getNodeType ( ) const [pure virtual]
 

An enum value representing the type of the underlying object.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

const XalanDOMString & XalanElement::getNodeValue ( ) const [pure virtual]
 

Gets the value of this node, depending on its type.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanDocument * XalanElement::getOwnerDocument ( ) const [pure virtual]
 

Gets the Document object associated with this node.

This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanNode * XalanElement::getParentNode ( ) const [pure virtual]
 

Gets the parent of this node.

All nodes, except Document, DocumentFragment, and Attr may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, a null Node is returned.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

const XalanDOMString & XalanElement::getPrefix ( ) const [pure virtual]
 

Get the namespace prefix of this node, or null if it is unspecified.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XalanSourceTreeElementA, XalanSourceTreeElementANS, XalanSourceTreeElementNA, XalanSourceTreeElementNANS, XercesElementWrapper, and XercesElementBridge.

XalanNode * XalanElement::getPreviousSibling ( ) const [pure virtual]
 

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

const XalanDOMString & XalanElement::getTagName ( ) const [pure virtual]
 

The name of the element.

For example, in: <elementExample id="demo"> ... </elementExample> , tagName has the value "elementExample". Note that this is case-preserving in XML, as are all of the operations of the DOM.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

bool XalanElement::hasChildNodes ( ) const [pure virtual]
 

This is a convenience method to allow easy determination of whether a node has any children.

Returns:
true if the node has any children, false if the node has no children.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanNode * XalanElement::insertBefore ( XalanNode * newChild,
XalanNode * refChild ) [pure virtual]
 

Inserts the node newChild before the existing child node refChild.

If refChild is null, insert newChild at the end of the list of children.
If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed. Note that a Node that has never been assigned to refer to an actual node is == null.

Parameters:
newChild   The node to insert.
refChild   The reference node, i.e., the node before which the new node must be inserted.
Returns:
The node being inserted.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

bool XalanElement::isIndexed ( ) const [pure virtual]
 

Determine if the document is node-order indexed.

Returns:
true if the document is indexed, otherwise false.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

bool XalanElement::isSupported ( const XalanDOMString & feature,
const XalanDOMString & version ) const [pure virtual]
 

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

Parameters:
feature   The string of the feature to test. This is the same name as what can be passed to the method hasFeature on DOMImplementation.
version   This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true.
Returns:
Returns true if the specified feature is supported on this node, false otherwise.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

void XalanElement::normalize ( ) [pure virtual]
 

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are no adjacent Text nodes.

This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.

Note: In cases where the document contains CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanElement & XalanElement::operator= ( const XalanElement & theSource ) [protected]
 

bool XalanElement::operator== ( const XalanElement & theRHS ) const [protected]
 

void XalanElement::removeAttribute ( const XalanDOMString & name ) [pure virtual]
 

Removes an attribute by name.

If the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.
To remove an attribute by local name and namespace URI, use the removeAttributeNS method.

Parameters:
name   The name of the attribute to remove.
Exceptions:
DOMException   NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

void XalanElement::removeAttributeNS ( const XalanDOMString & namespaceURI,
const XalanDOMString & localName ) [pure virtual]
 

Removes an attribute by local name and namespace URI.

If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix.
HTML-only DOM implementations do not need to implement this method.

Parameters:
namespaceURI   The namespace URI of the attribute to remove.
localName   The local name of the attribute to remove.
Exceptions:
DOMException   NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanAttr * XalanElement::removeAttributeNode ( XalanAttr * oldAttr ) [pure virtual]
 

Removes the specified attribute node.

If the removed Attr has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix, when applicable.

Parameters:
oldAttr   The Attr node to remove from the attribute list.
Returns:
The Attr node that was removed.
Exceptions:
DOMException   NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanNode * XalanElement::removeChild ( XalanNode * oldChild ) [pure virtual]
 

Removes the child node indicated by oldChild from the list of children, and returns it.

Parameters:
oldChild   The node being removed.
Returns:
The node removed.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanNode * XalanElement::replaceChild ( XalanNode * newChild,
XalanNode * oldChild ) [pure virtual]
 

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order.

If the newChild is already in the tree, it is first removed.

Parameters:
newChild   The new node to put in the child list.
oldChild   The node being replaced in the list.
Returns:
The node replaced.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

void XalanElement::setAttribute ( const XalanDOMString & name,
const XalanDOMString & value ) [pure virtual]
 

Adds a new attribute.

If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode to assign it as the value of an attribute.

Parameters:
name   The name of the attribute to create or alter.
value   Value to set in string form.
Exceptions:
DOMException   INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

void XalanElement::setAttributeNS ( const XalanDOMString & namespaceURI,
const XalanDOMString & qualifiedName,
const XalanDOMString & value ) [pure virtual]
 

Adds a new attribute.

If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the new attribute is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace". If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create a Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNodeNS or setAttributeNode to assign it as the value of an attribute.

Parameters:
namespaceURI   The namespace URI of the attribute to create or alter.
localName   The local name of the attribute to create or alter.
value   The value to set in string form.
Exceptions:
DOMException   INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix that is "xml" and the namespaceURI is neither null nor an empty string nor "http://www.w3.org/XML/1998/namespace", or if the qualifiedName has a prefix that is "xmlns" but the namespaceURI is neither null nor an empty string, or if if the qualifiedName has a prefix different from "xml" and "xmlns" and the namespaceURI is null or an empty string.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanAttr * XalanElement::setAttributeNode ( XalanAttr * newAttr ) [pure virtual]
 

Adds a new attribute.

If an attribute with that name (nodeName) is already present in the element, it is replaced by the new one.

Parameters:
newAttr   The Attr node to add to the attribute list.
Returns:
If the newAttr attribute replaces an existing attribute, the replaced Attr node is returned, otherwise null is returned.
Exceptions:
DOMException   WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

XalanAttr * XalanElement::setAttributeNodeNS ( XalanAttr * newAttr ) [pure virtual]
 

Adds a new attribute.

If an attribute with that local name and namespace URI is already present in the element, it is replaced by the new one.

Parameters:
newAttr   The Attr node to add to the attribute list.
Returns:
If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr node is returned, otherwise null is returned.
Exceptions:
DOMException   WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

void XalanElement::setNodeValue ( const XalanDOMString & nodeValue ) [pure virtual]
 

Sets the value of the node.

Any node which can have a nodeValue (

See also:
getNodeValue) will also accept requests to set it to a string. The exact response to this varies from node to node -- Attribute, for example, stores its values in its children and has to replace them with a new Text holding the replacement value.

For most types of Node, value is null and attempting to set it will throw DOMException(NO_MODIFICATION_ALLOWED_ERR). This will also be thrown if the node is read-only.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

void XalanElement::setPrefix ( const XalanDOMString & prefix ) [pure virtual]
 

Set the namespace prefix of this node.

Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.

Note also that changing the prefix of an attribute, that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.

Parameters:
prefix   The prefix of this node.
Exceptions:
DOMException   INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix is malformed, if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", if specified prefix is "xmlns" and the namespaceURI is neither null nor an empty string, or if the localName is null.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeElement, XercesElementWrapper, and XercesElementBridge.

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

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo