#include <xalanc/XalanDOM/XalanDocument.hpp>

Inheritance diagram for xalanc::XalanDocument:

Collaboration diagram for xalanc::XalanDocument:

Public Member Functions
	XalanDocument ()

virtual	~XalanDocument ()

virtual const XalanDOMString &	getNodeName () const =0
	Gets the name of this node, depending on its type. More...

virtual const XalanDOMString &	getNodeValue () 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 XalanNode *	getParentNode () const =0
	Gets the parent of this node. More...

virtual const XalanNodeList *	getChildNodes () const =0
	Gets a `NodeList` that contains all children of this node. More...

virtual XalanNode *	getFirstChild () const =0
	Gets the first child of this node. More...

virtual XalanNode *	getLastChild () const =0
	Gets the last child of this node. More...

virtual XalanNode *	getPreviousSibling () const =0
	Gets the node immediately preceding this node. More...

virtual XalanNode *	getNextSibling () const =0
	Gets the node immediately following this node. More...

virtual const XalanNamedNodeMap *	getAttributes () const =0
	Gets a `NamedNodeMap` containing the attributes of this node (if it is an `Element`) or `null` otherwise. More...

virtual XalanDocument *	getOwnerDocument () const =0
	Gets the `Document` object associated with this node. More...

virtual const XalanDOMString &	getNamespaceURI () const =0
	Get the namespace URI of this node, or `null` if it is unspecified. More...

virtual const XalanDOMString &	getPrefix () const =0
	Get the namespace prefix of this node, or `null` if it is unspecified. More...

virtual const XalanDOMString &	getLocalName () const =0
	Returns the local part of the qualified name 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...

virtual XalanElement *	getDocumentElement () const =0
	Return a reference to the root element of the document. More...

virtual XalanElement *	getElementById (const XalanDOMString &elementId) const =0
	Returns the `Element` whose ID is given by `elementId`. More...

Public Member Functions inherited from xalanc::XalanNode
	XalanNode ()

virtual	~XalanNode ()

Protected Member Functions
	XalanDocument (const XalanDocument &theSource)

XalanDocument &	operator= (const XalanDocument &theSource)

bool	operator== (const XalanDocument &theRHS) const

Protected Member Functions inherited from xalanc::XalanNode
	XalanNode (const XalanNode &theSource)

XalanNode &	operator= (const XalanNode &theSource)

bool	operator== (const XalanNode &theRHS) const

Additional Inherited Members
Public Types inherited from xalanc::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

Detailed Description

Definition at line 36 of file XalanDocument.hpp.

Constructor & Destructor Documentation

◆ XalanDocument() [1/2]

xalanc::XalanDocument::XalanDocument ( )

◆ ~XalanDocument()

virtual xalanc::XalanDocument::~XalanDocument ( )

virtual

◆ XalanDocument() [2/2]

xalanc::XalanDocument::XalanDocument ( const XalanDocument & theSource )

protected

Member Function Documentation

◆ getAttributes()

virtual const XalanNamedNodeMap* xalanc::XalanDocument::getAttributes ( ) const

pure virtual

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentWrapper, and xalanc::XercesDocumentBridge.

◆ getChildNodes()

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentWrapper, and xalanc::XercesDocumentBridge.

◆ getDocumentElement()

virtual XalanElement* xalanc::XalanDocument::getDocumentElement ( ) const

pure virtual

Return a reference to the root element of the document.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentBridge, and xalanc::XercesDocumentWrapper.

◆ getElementById()

virtual XalanElement* xalanc::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.

Parameters

elementId The unique id value for an element.

Returns: The matching element.

Implemented in xalanc::XercesDocumentBridge, xalanc::XalanSourceTreeDocument, and xalanc::XercesDocumentWrapper.

◆ getFirstChild()

virtual XalanNode* xalanc::XalanDocument::getFirstChild ( ) const

pure virtual

Gets the first child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentWrapper, and xalanc::XercesDocumentBridge.

◆ getIndex()

virtual IndexType xalanc::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.

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentBridge, and xalanc::XercesDocumentWrapper.

◆ getLastChild()

virtual XalanNode* xalanc::XalanDocument::getLastChild ( ) const

pure virtual

Gets the last child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentWrapper, and xalanc::XercesDocumentBridge.

◆ getLocalName()

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentBridge, and xalanc::XercesDocumentWrapper.

◆ getNamespaceURI()

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentBridge, and xalanc::XercesDocumentWrapper.

◆ getNextSibling()

virtual XalanNode* xalanc::XalanDocument::getNextSibling ( ) const

pure virtual

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentWrapper, and xalanc::XercesDocumentBridge.

◆ getNodeName()

virtual const XalanDOMString& xalanc::XalanDocument::getNodeName ( ) const

pure virtual

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentWrapper, and xalanc::XercesDocumentBridge.

◆ getNodeType()

virtual NodeType xalanc::XalanDocument::getNodeType ( ) const

pure virtual

An enum value representing the type of the underlying object.

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentWrapper, and xalanc::XercesDocumentBridge.

◆ getNodeValue()

virtual const XalanDOMString& xalanc::XalanDocument::getNodeValue ( ) const

pure virtual

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentWrapper, and xalanc::XercesDocumentBridge.

◆ getOwnerDocument()

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentWrapper, and xalanc::XercesDocumentBridge.

◆ getParentNode()

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeDocument, xalanc::XercesDocumentWrapper, and xalanc::XercesDocumentBridge.