Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.9

XercesDocumentFragmentBridge Class Reference

This class is deprecated. More...

Inheritance diagram for XercesDocumentFragmentBridge:

[legend]Collaboration diagram for XercesDocumentFragmentBridge:

[legend]List of all members.

Public Types

typedef XERCES_CPP_NAMESPACE_QUALIFIER
DOM_DocumentFragment DOM_DocumentFragmentType

Public Member Functions

XercesDocumentFragmentBridge (const DOM_DocumentFragmentType &theXercesDOMDocumentFragment, const XercesBridgeNavigator &theNavigator)
virtual ~XercesDocumentFragmentBridge ()
virtual const XalanDOMString & getNodeName () const
virtual const XalanDOMString & getNodeValue () const
Gets the value of this node, depending on its type.
virtual NodeType getNodeType () const
An enum value representing the type of the underlying object.
virtual XalanNode * getParentNode () const
Gets the parent of this node.
virtual const XalanNodeList * getChildNodes () const
Gets a NodeList that contains all children of this node.
virtual XalanNode * getFirstChild () const
Gets the first child of this node.
virtual XalanNode * getLastChild () const
Gets the last child of this node.
virtual XalanNode * getPreviousSibling () const
Gets the node immediately preceding this node.
virtual XalanNode * getNextSibling () const
Gets the node immediately following this node.
virtual const XalanNamedNodeMap * getAttributes () const
Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
virtual XalanDocument * getOwnerDocument () const
Gets the DOM_Document object associated with this node.

Cloning function.

virtual XercesDocumentFragmentBridge * cloneNode (bool deep) const
Returns a duplicate of this node.

Functions to modify the DOM Node.

virtual XalanNode * insertBefore (XalanNode *newChild, XalanNode *refChild)
Inserts the node newChild before the existing child node refChild.
virtual XalanNode * replaceChild (XalanNode *newChild, XalanNode *oldChild)
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
virtual XalanNode * removeChild (XalanNode *oldChild)
Removes the child node indicated by oldChild from the list of children, and returns it.
virtual XalanNode * appendChild (XalanNode *newChild)
Adds the node newChild to the end of the list of children of this node.

Query functions.

virtual bool hasChildNodes () const
This is a convenience method to allow easy determination of whether a node has any children.

Set functions.

virtual void setNodeValue (const XalanDOMString &nodeValue)
Sets the value of the node.

Functions introduced in DOM Level 2.

virtual void normalize ()
Puts all DOM_Text nodes in the full depth of the sub-tree underneath this DOM_Node, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates DOM_Text nodes, i.e., there are no adjacent DOM_Text nodes.
virtual bool isSupported (const XalanDOMString &feature, const XalanDOMString &version) const
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
virtual const XalanDOMString & getNamespaceURI () const
Get the namespace URI of this node, or null if it is unspecified.
virtual const XalanDOMString & getPrefix () const
Get the namespace prefix of this node, or null if it is unspecified.
virtual const XalanDOMString & getLocalName () const
Returns the local part of the qualified name of this node.
virtual void setPrefix (const XalanDOMString &prefix)
Set the namespace prefix of this node.
virtual bool isIndexed () const
Determine if the document is node-order indexed.
virtual IndexType getIndex () const
Get the node's index.
DOM_DocumentFragmentType getXercesNode () const
Get the Xerces node this instance represent.

Detailed Description

This class is deprecated.

Deprecated:: This class is part of the deprecated Xerces DOM bridge.

Member Typedef Documentation

typedef XERCES_CPP_NAMESPACE_QUALIFIER DOM_DocumentFragment XercesDocumentFragmentBridge::DOM_DocumentFragmentType

Constructor & Destructor Documentation

XercesDocumentFragmentBridge::XercesDocumentFragmentBridge ( const DOM_DocumentFragmentType & theXercesDOMDocumentFragment,

const XercesBridgeNavigator & theNavigator

)

virtual XercesDocumentFragmentBridge::~XercesDocumentFragmentBridge ( ) [virtual]

Member Function Documentation

virtual XalanNode* XercesDocumentFragmentBridge::appendChild ( XalanNode * newChild ) [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.

Implements XalanDocumentFragment.

virtual XercesDocumentFragmentBridge* XercesDocumentFragmentBridge::cloneNode ( bool deep ) const [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.

Implements XalanDocumentFragment.

virtual const XalanNamedNodeMap* XercesDocumentFragmentBridge::getAttributes ( ) const [virtual]

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

Implements XalanDocumentFragment.

virtual const XalanNodeList* XercesDocumentFragmentBridge::getChildNodes ( ) const [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.
Implements XalanDocumentFragment.

virtual XalanNode* XercesDocumentFragmentBridge::getFirstChild ( ) const [virtual]

Gets the first child of this node.
If there is no such node, this returns null.
Implements XalanDocumentFragment.

virtual IndexType XercesDocumentFragmentBridge::getIndex ( ) const [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.

Implements XalanDocumentFragment.

virtual XalanNode* XercesDocumentFragmentBridge::getLastChild ( ) const [virtual]

Gets the last child of this node.
If there is no such node, this returns null.
Implements XalanDocumentFragment.

virtual const XalanDOMString& XercesDocumentFragmentBridge::getLocalName ( ) const [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 DOM_Document interface, it is null.
Implements XalanDocumentFragment.

virtual const XalanDOMString& XercesDocumentFragmentBridge::getNamespaceURI ( ) const [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.
Implements XalanDocumentFragment.

virtual XalanNode* XercesDocumentFragmentBridge::getNextSibling ( ) const [virtual]

Gets the node immediately following this node.
If there is no such node, this returns null.
Implements XalanDocumentFragment.

virtual const XalanDOMString& XercesDocumentFragmentBridge::getNodeName ( ) const [virtual]

Implements XalanDocumentFragment.

virtual NodeType XercesDocumentFragmentBridge::getNodeType ( ) const [virtual]

An enum value representing the type of the underlying object.

Implements XalanDocumentFragment.

virtual const XalanDOMString& XercesDocumentFragmentBridge::getNodeValue ( ) const [virtual]

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

Implements XalanDocumentFragment.

virtual XalanDocument* XercesDocumentFragmentBridge::getOwnerDocument ( ) const [virtual]

Gets the DOM_Document object associated with this node.
This is also the DOM_Document object used to create new nodes. When this node is a DOM_Document or a DOM_DocumentType which is not used with any DOM_Document yet, this is null.
Implements XalanDocumentFragment.

virtual XalanNode* XercesDocumentFragmentBridge::getParentNode ( ) const [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 DOM_Node is returned.
Implements XalanDocumentFragment.

virtual const XalanDOMString& XercesDocumentFragmentBridge::getPrefix ( ) const [virtual]

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

Implements XalanDocumentFragment.

virtual XalanNode* XercesDocumentFragmentBridge::getPreviousSibling ( ) const [virtual]

Gets the node immediately preceding this node.
If there is no such node, this returns null.
Implements XalanDocumentFragment.

DOM_DocumentFragmentType XercesDocumentFragmentBridge::getXercesNode ( ) const

Get the Xerces node this instance represent.

Returns:
The Xerces node

virtual bool XercesDocumentFragmentBridge::hasChildNodes ( ) const [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.

Implements XalanDocumentFragment.

virtual XalanNode* XercesDocumentFragmentBridge::insertBefore ( XalanNode * newChild,

XalanNode * refChild

) [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 DOM_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.

Implements XalanDocumentFragment.

virtual bool XercesDocumentFragmentBridge::isIndexed ( ) const [virtual]

Determine if the document is node-order indexed.

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

Implements XalanDocumentFragment.

virtual bool XercesDocumentFragmentBridge::isSupported ( const XalanDOMString & feature,

const XalanDOMString & version

) const [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.

Implements XalanDocumentFragment.

virtual void XercesDocumentFragmentBridge::normalize ( ) [virtual]

Puts all DOM_Text nodes in the full depth of the sub-tree underneath this DOM_Node, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates DOM_Text nodes, i.e., there are no adjacent DOM_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 DOM_CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between DOM_Text nodes and DOM_CDATASection nodes.
Implements XalanDocumentFragment.

virtual XalanNode* XercesDocumentFragmentBridge::removeChild ( XalanNode * oldChild ) [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.

Implements XalanDocumentFragment.

virtual XalanNode* XercesDocumentFragmentBridge::replaceChild ( XalanNode * newChild,

XalanNode * oldChild

) [virtual]

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
If newChild is a DOM_DocumentFragment object, oldChild is replaced by all of the DOM_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.

Implements XalanDocumentFragment.

virtual void XercesDocumentFragmentBridge::setNodeValue ( const XalanDOMString & nodeValue ) [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.
Implements XalanDocumentFragment.

virtual void XercesDocumentFragmentBridge::setPrefix ( const XalanDOMString & prefix ) [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 DOM_Element and DOM_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.

Implements XalanDocumentFragment.

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

XercesDocumentFragmentBridge.hpp

Interpreting class diagrams

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