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  

XercesProcessingInstructionWrapper Class Reference

#include <XercesProcessingInstructionWrapper.hpp>

Inheritance diagram for XercesProcessingInstructionWrapper:

Inheritance graph
[legend]
Collaboration diagram for XercesProcessingInstructionWrapper:

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.
Get functions.
Set functions.

Static Public Methods

Constructor & Destructor Documentation

XercesProcessingInstructionWrapper::XercesProcessingInstructionWrapper ( const DOMProcessingInstructionType * theXercesDOMProcessingInstruction,
const XercesWrapperNavigator & theNavigator )
 

XercesProcessingInstructionWrapper::~XercesProcessingInstructionWrapper ( ) [virtual]
 

Member Function Documentation

XalanNode * XercesProcessingInstructionWrapper::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.

Reimplemented from XalanProcessingInstruction.

XercesProcessingInstructionWrapper * XercesProcessingInstructionWrapper::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.

Reimplemented from XalanProcessingInstruction.

XercesProcessingInstructionWrapper * XercesProcessingInstructionWrapper::create ( MemoryManagerType & theManager,
const DOMProcessingInstructionType * theXercesDOMProcessingInstruction,
const XercesWrapperNavigator & theNavigator ) [static]
 

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

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

Reimplemented from XalanProcessingInstruction.

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

Reimplemented from XalanProcessingInstruction.

const XalanDOMString & XercesProcessingInstructionWrapper::getData ( ) const [virtual]
 

The content of this processing instruction.

This is from the first non white space character after the target to the character immediately preceding the ?>.

Exceptions:
DOMException   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Reimplemented from XalanProcessingInstruction.

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

Gets the first child of this node.

If there is no such node, this returns null.

Reimplemented from XalanProcessingInstruction.

IndexType XercesProcessingInstructionWrapper::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.

Reimplemented from XalanProcessingInstruction.

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

Gets the last child of this node.

If there is no such node, this returns null.

Reimplemented from XalanProcessingInstruction.

const XalanDOMString & XercesProcessingInstructionWrapper::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 DOMDocument interface, it is null.

Reimplemented from XalanProcessingInstruction.

const XalanDOMString & XercesProcessingInstructionWrapper::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.

Reimplemented from XalanProcessingInstruction.

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

Gets the node immediately following this node.

If there is no such node, this returns null.

Reimplemented from XalanProcessingInstruction.

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

Reimplemented from XalanProcessingInstruction.

NodeType XercesProcessingInstructionWrapper::getNodeType ( ) const [virtual]
 

An enum value representing the type of the underlying object.

Reimplemented from XalanProcessingInstruction.

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

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

Reimplemented from XalanProcessingInstruction.

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

Gets the DOMDocument object associated with this node.

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

Reimplemented from XalanProcessingInstruction.

XalanNode * XercesProcessingInstructionWrapper::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 DOMNode is returned.

Reimplemented from XalanProcessingInstruction.

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

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

Reimplemented from XalanProcessingInstruction.

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

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Reimplemented from XalanProcessingInstruction.

const XalanDOMString & XercesProcessingInstructionWrapper::getTarget ( ) const [virtual]
 

The target of this processing instruction.

XML defines this as being the first token following the markup that begins the processing instruction.

Reimplemented from XalanProcessingInstruction.

const DOMProcessingInstructionType * XercesProcessingInstructionWrapper::getXercesNode ( ) const
 

Get the Xerces node this instance represent.

Returns:
The Xerces node

bool XercesProcessingInstructionWrapper::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.

Reimplemented from XalanProcessingInstruction.

XalanNode * XercesProcessingInstructionWrapper::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 DOMNode 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 XalanProcessingInstruction.

bool XercesProcessingInstructionWrapper::isIndexed ( ) const [virtual]
 

Determine if the document is node-order indexed.

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

Reimplemented from XalanProcessingInstruction.

bool XercesProcessingInstructionWrapper::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.

Reimplemented from XalanProcessingInstruction.

void XercesProcessingInstructionWrapper::normalize ( ) [virtual]
 

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

Reimplemented from XalanProcessingInstruction.

XalanNode * XercesProcessingInstructionWrapper::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.

Reimplemented from XalanProcessingInstruction.

XalanNode * XercesProcessingInstructionWrapper::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 DOMDocumentFragment object, oldChild is replaced by all of the DOMDocumentFragment 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 XalanProcessingInstruction.

void XercesProcessingInstructionWrapper::setData ( const XalanDOMString & data ) [virtual]
 

Sets the content of this processing instruction.

This is from the first non white space character after the target to the character immediately preceding the ?>.

Parameters:
data   The string containing the processing instruction

Reimplemented from XalanProcessingInstruction.

void XercesProcessingInstructionWrapper::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.

Reimplemented from XalanProcessingInstruction.

void XercesProcessingInstructionWrapper::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 DOMElement and DOMAttr 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 XalanProcessingInstruction.

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