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  

XalanDocument Class Reference

#include <XalanDocument.hpp>

Inheritance diagram for XalanDocument:

Inheritance graph
[legend]
Collaboration diagram for XalanDocument:

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.
Getter functions
Functions introduced in DOM Level 2.

Protected Methods

Constructor & Destructor Documentation

XalanDocument::XalanDocument ( )
 

XalanDocument::~XalanDocument ( ) [virtual]
 

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

Member Function Documentation

XalanNode * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanDocument * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanAttr * XalanDocument::createAttribute ( const XalanDOMString & name ) [pure virtual]
 

Creates an Attr of the given name.

Note that the Attr instance can then be attached to an Element using the DOMElement::setAttribute() method.

Parameters:
name   The name of the attribute.
Returns:
A new Attr object with the nodeName attribute set to name, and localName, prefix, and namespaceURI set to null.
Exceptions:
DOMException   INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanAttr * XalanDocument::createAttributeNS ( const XalanDOMString & namespaceURI,
const XalanDOMString & qualifiedName ) [pure virtual]
 

Creates an attribute of the given qualified name and namespace URI.

"Experimental - subject to change"

Parameters:
namespaceURI   The namespace URI of the attribute to create.
qualifiedName   The qualified name of the attribute to instantiate.
Returns:
A new Attr object.
Exceptions:
DOMException   INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix and the namespaceURI is null or an empty string, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from "http://www.w3.org/XML/1998/namespace", if the qualifiedName has a prefix that is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the qualifiedName is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/".

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanCDATASection * XalanDocument::createCDATASection ( const XalanDOMString & data ) [pure virtual]
 

Creates a CDATASection node whose value is the specified string.

Parameters:
data   The data for the CDATASection contents.
Returns:
A CDATASection object.
Exceptions:
DOMException   NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanComment * XalanDocument::createComment ( const XalanDOMString & data ) [pure virtual]
 

Creates a Comment node given the specified string.

Parameters:
data   The data for the comment.
Returns:
A Comment that references the newly created comment node.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanDocumentFragment * XalanDocument::createDocumentFragment ( ) [pure virtual]
 

Creates an empty DocumentFragment object.

Returns:
A DocumentFragment that references the newly created document fragment.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanElement * XalanDocument::createElement ( const XalanDOMString & tagName ) [pure virtual]
 

Creates an element of the type specified.

Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.

Parameters:
tagName   The name of the element type to instantiate.
Returns:
A Element that reference the new element.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanElement * XalanDocument::createElementNS ( const XalanDOMString & namespaceURI,
const XalanDOMString & qualifiedName ) [pure virtual]
 

Creates an element of the given qualified name and namespace URI.

"Experimental - subject to change"

Parameters:
namespaceURI   The namespace URI of the element to create.
qualifiedName   The qualified name of the element type to instantiate.
Returns:
A new Element object.
Exceptions:
DOMException   INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix and the namespaceURI is null or an empty string, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from "http://www.w3.org/XML/1998/namespace".

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanEntityReference * XalanDocument::createEntityReference ( const XalanDOMString & name ) [pure virtual]
 

Creates an EntityReference object.

Parameters:
name   The name of the entity to reference.
Returns:
A EntityReference that references the newly created EntityReference node.
Exceptions:
DOMException   INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanProcessingInstruction * XalanDocument::createProcessingInstruction ( const XalanDOMString & target,
const XalanDOMString & data ) [pure virtual]
 

Creates a ProcessingInstruction node given the specified name and data strings.

Parameters:
target   The target part of the processing instruction.
data   The data for the node.
Returns:
A ProcessingInstruction that references the newly created PI node.
Exceptions:
DOMException   INVALID_CHARACTER_ERR: Raised if an illegal character is specified.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanText * XalanDocument::createTextNode ( const XalanDOMString & data ) [pure virtual]
 

Creates a Text node given the specified string.

Parameters:
data   The data for the node.
Returns:
A Text object that references the newly created text node.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

const XalanNamedNodeMap * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

const XalanNodeList * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanDocumentType * XalanDocument::getDoctype ( ) const [pure virtual]
 

Get Document Type Declaration (see DocumentType) associated with this document.

For documents without a document type declaration this returns null reference object. The DOM Level 1 does not support editing the Document Type Declaration, therefore docType cannot be altered in any way.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

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

Return a reference to the root element of the document.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanElement * XalanDocument::getElementById ( const XalanDOMString & elementId ) const [pure virtual]
 

Returns the Element whose ID is given by elementId.

If no such element exists, returns null. Behavior is not defined if more than one element has this ID.

Note: The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null.

"Experimental - subject to change"

Parameters:
elementId   The unique id value for an element.
Returns:
The matching element.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanNodeList * XalanDocument::getElementsByTagName ( const XalanDOMString & tagname ) const [pure virtual]
 

Returns a NodeList of all the elements with a given tag name.

The returned node list is "live", in that changes to the document tree made after a nodelist was initially returned will be immediately reflected in the node list.

The elements in the node list are ordered in the same order in which they would be encountered in a preorder traversal of the Document tree.

Parameters:
tagname   The name of the tag to match on. The special value "*" matches all tags.
Returns:
A reference to a NodeList containing all the matched Elements.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanNodeList * XalanDocument::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.

"Experimental - subject to change"

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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanNode * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanDOMImplementation * XalanDocument::getImplementation ( ) const [pure virtual]
 

Return the DOMImplementation object that handles this document.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

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

Get the node's index.

Valid only if isIndexed() 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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanNode * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

const XalanDOMString & XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

const XalanDOMString & XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanNode * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

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

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

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

An enum value representing the type of the underlying object.

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

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

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

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanDocument * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanNode * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

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

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

Reimplemented from XalanNode.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanNode * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

bool XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanNode * XalanDocument::importNode ( XalanNode * importedNode,
bool deep ) [pure virtual]
 

Imports a node from another document to this document.

The returned node has no parent (parentNode is null). The source node is not altered or removed from the original document; this method creates a new copy of the source node.
For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node's nodeName and nodeType, plus the attributes related to namespaces (prefix and namespaces URI).

"Experimental - subject to change"

Parameters:
importedNode   The node to import.
deep   If true, recursively import the subtree under the specified node; if false, import only the node itself, as explained above. This does not apply to Attr, EntityReference, and Notation nodes.
Returns:
The imported node that belongs to this Document.
Exceptions:
DOMException   NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.

Reimplemented in XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanNode * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

bool XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

bool XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

void XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

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

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

XalanNode * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

XalanNode * XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

void XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

void XalanDocument::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 XalanSourceTreeDocument, XercesDocumentWrapper, and XercesDocumentBridge.

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