Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Member Functions | Static Public Member Functions | List of all members
XercesProcessingInstructionWrapper Class Reference
Inheritance diagram for XercesProcessingInstructionWrapper:
XalanProcessingInstruction XalanNode

Public Member Functions

 XercesProcessingInstructionWrapper (const DOMProcessingInstructionType *theXercesDOMProcessingInstruction, const XercesWrapperNavigator &theNavigator)
virtual ~XercesProcessingInstructionWrapper ()
virtual const XalanDOMStringgetNodeName () const
virtual const XalanDOMStringgetNodeValue () 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 XalanNodegetParentNode () const
 Gets the parent of this node.
virtual const XalanNodeListgetChildNodes () const
 Gets a NodeList that contains all children of this node.
virtual XalanNodegetFirstChild () const
 Gets the first child of this node.
virtual XalanNodegetLastChild () const
 Gets the last child of this node.
virtual XalanNodegetPreviousSibling () const
 Gets the node immediately preceding this node.
virtual XalanNodegetNextSibling () const
 Gets the node immediately following this node.
virtual const XalanNamedNodeMapgetAttributes () const
 Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
virtual XalanDocumentgetOwnerDocument () const
 Gets the DOMDocument object associated with this node.
const
DOMProcessingInstructionType
getXercesNode () const
 Get the Xerces node this instance represent.
Cloning function.
virtual
XercesProcessingInstructionWrapper
cloneNode (bool deep) const
 Returns a duplicate of this node.
Functions to modify the DOM Node.
virtual XalanNodeinsertBefore (XalanNode *newChild, XalanNode *refChild)
 Inserts the node newChild before the existing child node refChild.
virtual XalanNodereplaceChild (XalanNode *newChild, XalanNode *oldChild)
 Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
virtual XalanNoderemoveChild (XalanNode *oldChild)
 Removes the child node indicated by oldChild from the list of children, and returns it.
virtual XalanNodeappendChild (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.
virtual void setData (const XalanDOMString &data)
 Sets the content of this processing instruction.
Functions introduced in DOM Level 2.
virtual void normalize ()
 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.
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 XalanDOMStringgetNamespaceURI () const
 Get the namespace URI of this node, or null if it is unspecified.
virtual const XalanDOMStringgetPrefix () const
 Get the namespace prefix of this node, or null if it is unspecified.
virtual const XalanDOMStringgetLocalName () 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.
Get functions.
virtual const XalanDOMStringgetTarget () const
 The target of this processing instruction.
virtual const XalanDOMStringgetData () const
 The content of this processing instruction.
- Public Member Functions inherited from XalanProcessingInstruction
 XalanProcessingInstruction ()
virtual ~XalanProcessingInstruction ()
- Public Member Functions inherited from XalanNode
 XalanNode ()
virtual ~XalanNode ()

Static Public Member Functions

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

Additional Inherited Members

- Public Types inherited from XalanNode
enum  NodeType {
  UNKNOWN_NODE = 0, ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3,
  CDATA_SECTION_NODE = 4, ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7,
  COMMENT_NODE = 8, DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11,
  NOTATION_NODE = 12
}
typedef unsigned long IndexType
- Protected Member Functions inherited from XalanProcessingInstruction
 XalanProcessingInstruction (const XalanProcessingInstruction &theSource)
XalanProcessingInstructionoperator= (const XalanProcessingInstruction &theSource)
bool operator== (const XalanProcessingInstruction &theRHS) const

Constructor & Destructor Documentation

XercesProcessingInstructionWrapper::XercesProcessingInstructionWrapper ( const DOMProcessingInstructionType theXercesDOMProcessingInstruction,
const XercesWrapperNavigator theNavigator 
)
virtual XercesProcessingInstructionWrapper::~XercesProcessingInstructionWrapper ( )
virtual

Member Function Documentation

virtual 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
newChildThe 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 XalanProcessingInstruction.

virtual 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
deepIf 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 XalanProcessingInstruction.

static XercesProcessingInstructionWrapper* XercesProcessingInstructionWrapper::create ( MemoryManagerType theManager,
const DOMProcessingInstructionType theXercesDOMProcessingInstruction,
const XercesWrapperNavigator theNavigator 
)
static
virtual const XalanNamedNodeMap* XercesProcessingInstructionWrapper::getAttributes ( ) const
virtual

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

Implements XalanProcessingInstruction.

virtual 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.

Implements XalanProcessingInstruction.

virtual 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
DOMExceptionNO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Implements XalanProcessingInstruction.

virtual XalanNode* XercesProcessingInstructionWrapper::getFirstChild ( ) const
virtual

Gets the first child of this node.

If there is no such node, this returns null.

Implements XalanProcessingInstruction.

virtual 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.

Implements XalanProcessingInstruction.

virtual XalanNode* XercesProcessingInstructionWrapper::getLastChild ( ) const
virtual

Gets the last child of this node.

If there is no such node, this returns null.

Implements XalanProcessingInstruction.

virtual 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.

Implements XalanProcessingInstruction.

virtual 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.

Implements XalanProcessingInstruction.

virtual XalanNode* XercesProcessingInstructionWrapper::getNextSibling ( ) const
virtual

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements XalanProcessingInstruction.

virtual const XalanDOMString& XercesProcessingInstructionWrapper::getNodeName ( ) const
virtual
virtual NodeType XercesProcessingInstructionWrapper::getNodeType ( ) const
virtual

An enum value representing the type of the underlying object.

Implements XalanProcessingInstruction.

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

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

Implements XalanProcessingInstruction.

virtual 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.

Implements XalanProcessingInstruction.

virtual 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.

Implements XalanProcessingInstruction.

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

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

Implements XalanProcessingInstruction.

virtual XalanNode* XercesProcessingInstructionWrapper::getPreviousSibling ( ) const
virtual

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements XalanProcessingInstruction.

virtual 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.

Implements XalanProcessingInstruction.

const DOMProcessingInstructionType* XercesProcessingInstructionWrapper::getXercesNode ( ) const

Get the Xerces node this instance represent.

Returns
The Xerces node
virtual 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.

Implements XalanProcessingInstruction.

virtual 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
newChildThe node to insert.
refChildThe reference node, i.e., the node before which the new node must be inserted.
Returns
The node being inserted.

Implements XalanProcessingInstruction.

virtual bool XercesProcessingInstructionWrapper::isIndexed ( ) const
virtual

Determine if the document is node-order indexed.

Returns
true if the document is indexed, otherwise false.

Implements XalanProcessingInstruction.

virtual 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
featureThe string of the feature to test. This is the same name as what can be passed to the method hasFeature on DOMImplementation.
versionThis 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 XalanProcessingInstruction.

virtual 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.

Implements XalanProcessingInstruction.

virtual XalanNode* XercesProcessingInstructionWrapper::removeChild ( XalanNode oldChild)
virtual

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

Parameters
oldChildThe node being removed.
Returns
The node removed.

Implements XalanProcessingInstruction.

virtual 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
newChildThe new node to put in the child list.
oldChildThe node being replaced in the list.
Returns
The node replaced.

Implements XalanProcessingInstruction.

virtual 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
dataThe string containing the processing instruction

Implements XalanProcessingInstruction.

virtual 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.

Implements XalanProcessingInstruction.

virtual 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
prefixThe prefix of this node.
Exceptions
DOMExceptionINVALID_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 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