Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Types | Public Member Functions | Protected Member Functions | List of all members
XalanNode Class Referenceabstract
Inheritance diagram for XalanNode:
XalanAttr XalanCharacterData XalanDocument XalanDocumentFragment XalanDocumentType XalanElement XalanEntity XalanEntityReference XalanNotation XalanProcessingInstruction

Public Types

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
 

Public Member Functions

 XalanNode ()
 
virtual ~XalanNode ()
 
virtual const XalanDOMStringgetNodeName () const =0
 
virtual const XalanDOMStringgetNodeValue () const =0
 Gets the value of this node, depending on its type. More...
 
virtual NodeType getNodeType () const =0
 An enum value representing the type of the underlying object. More...
 
virtual XalanNodegetParentNode () const =0
 Gets the parent of this node. More...
 
virtual const XalanNodeListgetChildNodes () const =0
 Gets a NodeList that contains all children of this node. More...
 
virtual XalanNodegetFirstChild () const =0
 Gets the first child of this node. More...
 
virtual XalanNodegetLastChild () const =0
 Gets the last child of this node. More...
 
virtual XalanNodegetPreviousSibling () const =0
 Gets the node immediately preceding this node. More...
 
virtual XalanNodegetNextSibling () const =0
 Gets the node immediately following this node. More...
 
virtual const XalanNamedNodeMapgetAttributes () const =0
 Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. More...
 
virtual XalanDocumentgetOwnerDocument () const =0
 Gets the Document object associated with this node. More...
 
Cloning function.
virtual XalanNodecloneNode (bool deep) const =0
 Returns a duplicate of this node. More...
 
Functions to modify the DOM Node.
virtual XalanNodeinsertBefore (XalanNode *newChild, XalanNode *refChild)=0
 Inserts the node newChild before the existing child node refChild. More...
 
virtual XalanNodereplaceChild (XalanNode *newChild, XalanNode *oldChild)=0
 Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. More...
 
virtual XalanNoderemoveChild (XalanNode *oldChild)=0
 Removes the child node indicated by oldChild from the list of children, and returns it. More...
 
virtual XalanNodeappendChild (XalanNode *newChild)=0
 Adds the node newChild to the end of the list of children of this node. More...
 
Query functions.
virtual bool hasChildNodes () const =0
 This is a convenience method to allow easy determination of whether a node has any children. More...
 
Set functions.
virtual void setNodeValue (const XalanDOMString &nodeValue)=0
 Sets the value of the node. More...
 
Functions introduced in DOM Level 2.
virtual void normalize ()=0
 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. More...
 
virtual bool isSupported (const XalanDOMString &feature, const XalanDOMString &version) const =0
 Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. More...
 
virtual const XalanDOMStringgetNamespaceURI () const =0
 Get the namespace URI of this node, or null if it is unspecified. More...
 
virtual const XalanDOMStringgetPrefix () const =0
 Get the namespace prefix of this node, or null if it is unspecified. More...
 
virtual const XalanDOMStringgetLocalName () const =0
 Returns the local part of the qualified name of this node. More...
 
virtual void setPrefix (const XalanDOMString &prefix)=0
 Set the namespace prefix of this node. More...
 
virtual bool isIndexed () const =0
 Determine if the document is node-order indexed. More...
 
virtual IndexType getIndex () const =0
 Get the node's index. More...
 

Protected Member Functions

 XalanNode (const XalanNode &theSource)
 
XalanNodeoperator= (const XalanNode &theSource)
 
bool operator== (const XalanNode &theRHS) const
 

Member Typedef Documentation

typedef unsigned long XalanNode::IndexType

Member Enumeration Documentation

Enumerator
UNKNOWN_NODE 
ELEMENT_NODE 
ATTRIBUTE_NODE 
TEXT_NODE 
CDATA_SECTION_NODE 
ENTITY_REFERENCE_NODE 
ENTITY_NODE 
PROCESSING_INSTRUCTION_NODE 
COMMENT_NODE 
DOCUMENT_NODE 
DOCUMENT_TYPE_NODE 
DOCUMENT_FRAGMENT_NODE 
NOTATION_NODE 

Constructor & Destructor Documentation

XalanNode::XalanNode ( )
virtual XalanNode::~XalanNode ( )
virtual
XalanNode::XalanNode ( const XalanNode theSource)
protected

Member Function Documentation

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

Implemented in XalanSourceTreeDocument, XalanSourceTreeComment, XalanSourceTreeText, XalanSourceTreeElement, XalanSourceTreeProcessingInstruction, XercesElementBridge, XalanSourceTreeAttr, XObjectResultTreeFragProxyText, XercesDocumentFragmentBridge, XercesDocumentTypeBridge, XercesEntityBridge, XercesTextBridge, XercesAttrBridge, XercesCDATASectionBridge, XercesCommentBridge, XercesEntityReferenceBridge, XercesNotationBridge, XercesProcessingInstructionBridge, XercesCDATASectionWrapper, XercesEntityReferenceWrapper, XercesEntityWrapper, XalanDocument, XercesDocumentTypeWrapper, XercesElementWrapper, XercesNotationWrapper, XercesProcessingInstructionWrapper, XercesAttrWrapper, XercesCommentWrapper, XercesTextWrapper, XalanElement, XalanAttr, XalanDocumentType, XalanCDATASection, XalanCharacterData, XalanComment, XalanText, XalanEntity, XalanEntityReference, XalanNotation, XalanProcessingInstruction, XercesDocumentWrapper, XercesDocumentBridge, XalanSourceTreeDocumentFragment, XObjectResultTreeFragProxyBase, XalanDocumentFragment, XalanSourceTreeElementA, XalanSourceTreeElementANS, XalanSourceTreeAttrNS, XalanSourceTreeElementNA, XalanSourceTreeElementNANS, XObjectResultTreeFragProxy, and XNodeSetResultTreeFragProxy.

virtual const XalanNamedNodeMap* XalanNode::getAttributes ( ) const
pure virtual
virtual const XalanNodeList* XalanNode::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.

Implemented in XalanSourceTreeDocument, XercesDocumentWrapper, XalanSourceTreeComment, XercesDocumentBridge, XalanSourceTreeText, XalanSourceTreeElement, XalanSourceTreeProcessingInstruction, XercesElementBridge, XalanSourceTreeAttr, XObjectResultTreeFragProxyText, XercesDocumentFragmentBridge, XercesDocumentTypeBridge, XercesEntityBridge, XercesTextBridge, XercesAttrBridge, XercesCDATASectionBridge, XercesCommentBridge, XercesEntityReferenceBridge, XercesNotationBridge, XercesProcessingInstructionBridge, XercesCDATASectionWrapper, XercesEntityReferenceWrapper, XercesEntityWrapper, XalanDocument, XercesDocumentTypeWrapper, XercesElementWrapper, XercesNotationWrapper, XercesProcessingInstructionWrapper, XercesAttrWrapper, XercesCommentWrapper, XercesTextWrapper, XalanDocumentType, XalanElement, XalanEntity, XalanAttr, XalanEntityReference, XalanNotation, XalanProcessingInstruction, XalanCDATASection, XalanCharacterData, XalanComment, XalanText, XalanSourceTreeDocumentFragment, XObjectResultTreeFragProxyBase, and XalanDocumentFragment.

virtual XalanNode* XalanNode::getFirstChild ( ) const
pure virtual
virtual IndexType XalanNode::getIndex ( ) const
pure virtual
virtual XalanNode* XalanNode::getLastChild ( ) const
pure virtual
virtual const XalanDOMString& XalanNode::getLocalName ( ) const
pure virtual
virtual const XalanDOMString& XalanNode::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.

Implemented in XalanSourceTreeComment, XalanSourceTreeText, XalanSourceTreeElement, XalanSourceTreeProcessingInstruction, XercesElementBridge, XalanSourceTreeAttr, XObjectResultTreeFragProxyText, XercesDocumentFragmentBridge, XercesDocumentTypeBridge, XercesEntityBridge, XercesTextBridge, XercesAttrBridge, XercesCDATASectionBridge, XercesEntityReferenceBridge, XercesCommentBridge, XercesNotationBridge, XercesProcessingInstructionBridge, XercesCDATASectionWrapper, XercesEntityReferenceWrapper, XercesEntityWrapper, XalanDocument, XercesDocumentTypeWrapper, XercesElementWrapper, XercesNotationWrapper, XercesProcessingInstructionWrapper, XercesAttrWrapper, XercesCommentWrapper, XercesTextWrapper, XalanElement, XalanAttr, XalanDocumentType, XalanCDATASection, XalanComment, XalanText, XalanCharacterData, XalanEntity, XalanEntityReference, XalanNotation, XalanProcessingInstruction, XalanSourceTreeDocument, XercesDocumentWrapper, XercesDocumentBridge, XalanSourceTreeDocumentFragment, XObjectResultTreeFragProxyBase, XalanDocumentFragment, XalanSourceTreeElementA, XalanSourceTreeElementANS, XalanSourceTreeAttrNS, XalanSourceTreeElementNA, and XalanSourceTreeElementNANS.

virtual XalanNode* XalanNode::getNextSibling ( ) const
pure virtual
virtual const XalanDOMString& XalanNode::getNodeName ( ) const
pure virtual
virtual NodeType XalanNode::getNodeType ( ) const
pure virtual
virtual const XalanDOMString& XalanNode::getNodeValue ( ) const
pure virtual
virtual XalanDocument* XalanNode::getOwnerDocument ( ) const
pure virtual
virtual XalanNode* XalanNode::getParentNode ( ) const
pure virtual
virtual const XalanDOMString& XalanNode::getPrefix ( ) const
pure virtual
virtual XalanNode* XalanNode::getPreviousSibling ( ) const
pure virtual
virtual bool XalanNode::hasChildNodes ( ) const
pure virtual
virtual XalanNode* XalanNode::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
newChildThe node to insert.
refChildThe reference node, i.e., the node before which the new node must be inserted.
Returns
The node being inserted.

Implemented in XalanSourceTreeComment, XalanSourceTreeDocument, XalanSourceTreeText, XalanSourceTreeElement, XalanSourceTreeProcessingInstruction, XercesElementBridge, XalanSourceTreeAttr, XObjectResultTreeFragProxyText, XercesDocumentFragmentBridge, XercesDocumentTypeBridge, XercesEntityBridge, XercesTextBridge, XercesAttrBridge, XercesCDATASectionBridge, XercesCommentBridge, XercesEntityReferenceBridge, XercesNotationBridge, XercesProcessingInstructionBridge, XercesCDATASectionWrapper, XercesEntityReferenceWrapper, XercesEntityWrapper, XalanDocument, XercesDocumentTypeWrapper, XercesElementWrapper, XercesNotationWrapper, XercesProcessingInstructionWrapper, XercesAttrWrapper, XercesCommentWrapper, XercesTextWrapper, XalanElement, XalanAttr, XalanDocumentType, XalanCDATASection, XalanCharacterData, XalanComment, XalanText, XalanEntity, XalanEntityReference, XalanNotation, XalanProcessingInstruction, XercesDocumentWrapper, XercesDocumentBridge, XalanSourceTreeDocumentFragment, XObjectResultTreeFragProxyBase, and XalanDocumentFragment.

virtual bool XalanNode::isIndexed ( ) const
pure virtual
virtual bool XalanNode::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
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.

Implemented in XalanSourceTreeComment, XalanSourceTreeText, XalanSourceTreeElement, XalanSourceTreeProcessingInstruction, XercesElementBridge, XalanSourceTreeAttr, XObjectResultTreeFragProxyText, XercesDocumentFragmentBridge, XercesDocumentTypeBridge, XercesEntityBridge, XercesTextBridge, XercesAttrBridge, XercesCDATASectionBridge, XercesEntityReferenceBridge, XercesCommentBridge, XercesNotationBridge, XercesProcessingInstructionBridge, XercesCDATASectionWrapper, XercesEntityReferenceWrapper, XercesEntityWrapper, XalanDocument, XercesDocumentTypeWrapper, XercesElementWrapper, XercesNotationWrapper, XercesProcessingInstructionWrapper, XercesAttrWrapper, XercesCommentWrapper, XercesTextWrapper, XalanElement, XalanAttr, XalanDocumentType, XalanCDATASection, XalanComment, XalanText, XalanCharacterData, XalanEntity, XalanEntityReference, XalanNotation, XalanProcessingInstruction, XalanSourceTreeDocument, XercesDocumentWrapper, XercesDocumentBridge, XalanSourceTreeDocumentFragment, XObjectResultTreeFragProxyBase, and XalanDocumentFragment.

virtual void XalanNode::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.

Implemented in XalanSourceTreeComment, XalanSourceTreeText, XalanSourceTreeElement, XalanSourceTreeProcessingInstruction, XercesElementBridge, XalanSourceTreeAttr, XObjectResultTreeFragProxyText, XercesDocumentFragmentBridge, XercesDocumentTypeBridge, XercesEntityBridge, XercesTextBridge, XercesAttrBridge, XercesCDATASectionBridge, XercesEntityReferenceBridge, XercesCommentBridge, XercesNotationBridge, XercesProcessingInstructionBridge, XercesCDATASectionWrapper, XercesEntityReferenceWrapper, XercesEntityWrapper, XalanDocument, XercesDocumentTypeWrapper, XercesElementWrapper, XercesNotationWrapper, XercesProcessingInstructionWrapper, XercesAttrWrapper, XercesCommentWrapper, XercesTextWrapper, XalanElement, XalanAttr, XalanDocumentType, XalanCDATASection, XalanComment, XalanText, XalanCharacterData, XalanEntity, XalanEntityReference, XalanNotation, XalanProcessingInstruction, XalanSourceTreeDocument, XercesDocumentWrapper, XercesDocumentBridge, XalanSourceTreeDocumentFragment, XObjectResultTreeFragProxyBase, and XalanDocumentFragment.

XalanNode& XalanNode::operator= ( const XalanNode theSource)
protected
bool XalanNode::operator== ( const XalanNode theRHS) const
protected
virtual XalanNode* XalanNode::removeChild ( XalanNode oldChild)
pure virtual
virtual XalanNode* XalanNode::replaceChild ( XalanNode newChild,
XalanNode oldChild 
)
pure virtual
virtual void XalanNode::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.

Implemented in XalanSourceTreeComment, XalanSourceTreeText, XalanSourceTreeElement, XalanSourceTreeProcessingInstruction, XercesElementBridge, XalanSourceTreeAttr, XObjectResultTreeFragProxyText, XercesDocumentFragmentBridge, XercesDocumentTypeBridge, XercesEntityBridge, XercesTextBridge, XercesAttrBridge, XercesCDATASectionBridge, XercesEntityReferenceBridge, XercesCommentBridge, XercesNotationBridge, XercesProcessingInstructionBridge, XercesCDATASectionWrapper, XercesEntityReferenceWrapper, XercesEntityWrapper, XalanDocument, XercesDocumentTypeWrapper, XercesElementWrapper, XercesNotationWrapper, XercesProcessingInstructionWrapper, XercesAttrWrapper, XercesCommentWrapper, XercesTextWrapper, XalanElement, XalanAttr, XalanDocumentType, XalanCDATASection, XalanComment, XalanText, XalanCharacterData, XalanEntity, XalanEntityReference, XalanNotation, XalanProcessingInstruction, XalanSourceTreeDocument, XercesDocumentWrapper, XercesDocumentBridge, XalanSourceTreeDocumentFragment, XObjectResultTreeFragProxyBase, and XalanDocumentFragment.

virtual void XalanNode::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
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.

Implemented in XalanSourceTreeComment, XalanSourceTreeText, XalanSourceTreeElement, XalanSourceTreeProcessingInstruction, XercesElementBridge, XalanSourceTreeAttr, XObjectResultTreeFragProxyText, XercesDocumentFragmentBridge, XercesDocumentTypeBridge, XercesEntityBridge, XercesTextBridge, XercesAttrBridge, XercesCDATASectionBridge, XercesEntityReferenceBridge, XercesCommentBridge, XercesNotationBridge, XercesProcessingInstructionBridge, XercesCDATASectionWrapper, XercesEntityReferenceWrapper, XercesEntityWrapper, XalanDocument, XercesDocumentTypeWrapper, XercesElementWrapper, XercesNotationWrapper, XercesProcessingInstructionWrapper, XercesAttrWrapper, XercesCommentWrapper, XercesTextWrapper, XalanElement, XalanAttr, XalanDocumentType, XalanCDATASection, XalanComment, XalanText, XalanCharacterData, XalanEntity, XalanEntityReference, XalanNotation, XalanProcessingInstruction, XalanSourceTreeDocument, XercesDocumentWrapper, XercesDocumentBridge, XalanSourceTreeDocumentFragment, XObjectResultTreeFragProxyBase, and XalanDocumentFragment.


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