#include <xalanc/XalanSourceTree/XalanSourceTreeElement.hpp>

Inheritance diagram for xalanc::XalanSourceTreeElement:

Collaboration diagram for xalanc::XalanSourceTreeElement:

Public Member Functions
	XalanSourceTreeElement (MemoryManager &theManager, const XalanDOMString &theTagName, XalanSourceTreeDocument theOwnerDocument, XalanNode theParentNode=0, XalanNode thePreviousSibling=0, XalanNode theNextSibling=0, IndexType theIndex=0)
	Constructor. More...

virtual	~XalanSourceTreeElement ()

MemoryManager &	getMemoryManager ()

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

virtual const XalanDOMString &	getNodeValue () const
	Gets the value of this node, depending on its type. More...

virtual NodeType	getNodeType () const
	An enum value representing the type of the underlying object. More...

virtual XalanNode *	getParentNode () const
	Gets the parent of this node. More...

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

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

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

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

virtual XalanNode *	getNextSibling () const
	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
	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
	Determine if the document is node-order indexed. More...

virtual IndexType	getIndex () const
	Get the node's index. More...

virtual const XalanDOMString &	getTagName () const
	The name of the element. More...

XalanSourceTreeDocument *	getDocument () const

void	setParent (XalanSourceTreeElement *theParent)

void	setParent (XalanSourceTreeDocumentFragment *theParent)

void	setPreviousSibling (XalanSourceTreeComment *thePreviousSibling)

void	setPreviousSibling (XalanSourceTreeElement *thePreviousSibling)

void	setPreviousSibling (XalanSourceTreeProcessingInstruction *thePreviousSibling)

void	setPreviousSibling (XalanSourceTreeText *thePreviousSibling)

void	appendSiblingNode (XalanSourceTreeComment *theSibling)

void	appendSiblingNode (XalanSourceTreeElement *theSibling)

void	appendSiblingNode (XalanSourceTreeProcessingInstruction *theSibling)

void	appendSiblingNode (XalanSourceTreeText *theSibling)

void	appendChildNode (XalanSourceTreeComment *theChild)

void	appendChildNode (XalanSourceTreeElement *theChild)

void	appendChildNode (XalanSourceTreeProcessingInstruction *theChild)

void	appendChildNode (XalanSourceTreeText *theChild)

void	setIndex (IndexType theIndex)

void	clearChildren ()
	Removes all of the children. More...

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

virtual	~XalanElement ()

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

virtual	~XalanNode ()

Protected Attributes
const XalanDOMString &	m_tagName

Static Protected Attributes
static const XalanDOMString	s_emptyString

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

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

XalanElement &	operator= (const XalanElement &theSource)

bool	operator== (const XalanElement &theRHS) const

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

XalanNode &	operator= (const XalanNode &theSource)

bool	operator== (const XalanNode &theRHS) const

Detailed Description

Definition at line 46 of file XalanSourceTreeElement.hpp.

Constructor & Destructor Documentation

◆ XalanSourceTreeElement()

xalanc::XalanSourceTreeElement::XalanSourceTreeElement	(	MemoryManager &	theManager,
		const XalanDOMString &	theTagName,
		XalanSourceTreeDocument *	theOwnerDocument,
		XalanNode *	theParentNode = `0`,
		XalanNode *	thePreviousSibling = `0`,
		XalanNode *	theNextSibling = `0`,
		IndexType	theIndex = `0`
	)

Constructor.

Parameters

theTagName	The tag name of the element
theOwnerDocument	The document that owns the instance
theAttributes	An array of pointers to the attribute instances for the element
theAttributeCount	The number of attributes.
theParentNode	The parent node, if any.
thePreviousSibling	The previous sibling, if any.
theNextSibling	The next sibling, if any.
theIndex	The document-order index of the node.

◆ ~XalanSourceTreeElement()

virtual xalanc::XalanSourceTreeElement::~XalanSourceTreeElement ( )

virtual

Member Function Documentation

◆ appendChildNode() [1/4]

void xalanc::XalanSourceTreeElement::appendChildNode ( XalanSourceTreeComment * theChild )

◆ appendChildNode() [2/4]

void xalanc::XalanSourceTreeElement::appendChildNode ( XalanSourceTreeElement * theChild )

◆ appendChildNode() [3/4]

void xalanc::XalanSourceTreeElement::appendChildNode ( XalanSourceTreeProcessingInstruction * theChild )

◆ appendChildNode() [4/4]

void xalanc::XalanSourceTreeElement::appendChildNode ( XalanSourceTreeText * theChild )

◆ appendSiblingNode() [1/4]

void xalanc::XalanSourceTreeElement::appendSiblingNode ( XalanSourceTreeComment * theSibling )

◆ appendSiblingNode() [2/4]

void xalanc::XalanSourceTreeElement::appendSiblingNode ( XalanSourceTreeElement * theSibling )

◆ appendSiblingNode() [3/4]

void xalanc::XalanSourceTreeElement::appendSiblingNode ( XalanSourceTreeProcessingInstruction * theSibling )

◆ appendSiblingNode() [4/4]

void xalanc::XalanSourceTreeElement::appendSiblingNode ( XalanSourceTreeText * theSibling )

◆ clearChildren()

void xalanc::XalanSourceTreeElement::clearChildren ( )

inline

Removes all of the children.

Since the owner document controls the lifetime of all nodes in the document, this just sets the first child to 0.

Definition at line 198 of file XalanSourceTreeElement.hpp.

◆ getAttributes()

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

pure virtual

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

Implements xalanc::XalanElement.

Implemented in xalanc::XalanSourceTreeElementA, and xalanc::XalanSourceTreeElementNA.

◆ getChildNodes()

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

Implements xalanc::XalanElement.

◆ getDocument()

XalanSourceTreeDocument* xalanc::XalanSourceTreeElement::getDocument ( ) const

inline

Definition at line 136 of file XalanSourceTreeElement.hpp.

◆ getFirstChild()

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

virtual

Gets the first child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanElement.

◆ getIndex()

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

◆ getLastChild()

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

virtual

Gets the last child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanElement.

◆ getLocalName()

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

Implemented in xalanc::XalanSourceTreeElementA, xalanc::XalanSourceTreeElementANS, xalanc::XalanSourceTreeElementNA, and xalanc::XalanSourceTreeElementNANS.

◆ getMemoryManager()

MemoryManager& xalanc::XalanSourceTreeElement::getMemoryManager ( )

inline

Definition at line 75 of file XalanSourceTreeElement.hpp.

◆ getNamespaceURI()

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

Implemented in xalanc::XalanSourceTreeElementA, xalanc::XalanSourceTreeElementANS, xalanc::XalanSourceTreeElementNA, and xalanc::XalanSourceTreeElementNANS.

◆ getNextSibling()

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

virtual

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements xalanc::XalanElement.

◆ getNodeName()

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

virtual

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

Implements xalanc::XalanElement.

◆ getNodeType()

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

virtual

An enum value representing the type of the underlying object.

Implements xalanc::XalanElement.

◆ getNodeValue()

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

virtual

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

Implements xalanc::XalanElement.

◆ getOwnerDocument()

virtual XalanDocument* xalanc::XalanSourceTreeElement::getOwnerDocument ( ) const

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::XalanElement.

◆ getParentNode()

virtual XalanNode* xalanc::XalanSourceTreeElement::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 Node is returned.

Implements xalanc::XalanElement.

◆ getPrefix()

virtual const XalanDOMString& xalanc::XalanSourceTreeElement::getPrefix ( ) const

pure virtual

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

Implements xalanc::XalanElement.

Implemented in xalanc::XalanSourceTreeElementA, xalanc::XalanSourceTreeElementANS, xalanc::XalanSourceTreeElementNA, and xalanc::XalanSourceTreeElementNANS.

◆ getPreviousSibling()

virtual XalanNode* xalanc::XalanSourceTreeElement::getPreviousSibling ( ) const

virtual

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements xalanc::XalanElement.

◆ getTagName()

virtual const XalanDOMString& xalanc::XalanSourceTreeElement::getTagName ( ) const

virtual

The name of the element.

For example, in: <elementExample id="demo"> ... </elementExample> , tagName has the value "elementExample". Note that this is case-preserving in XML, as are all of the operations of the DOM.

Implements xalanc::XalanElement.

◆ isIndexed()

virtual bool xalanc::XalanSourceTreeElement::isIndexed ( ) const

virtual

Determine if the document is node-order indexed.

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

Implements xalanc::XalanElement.

◆ setIndex()

void xalanc::XalanSourceTreeElement::setIndex ( IndexType theIndex )

inline

Definition at line 187 of file XalanSourceTreeElement.hpp.

◆ setParent() [1/2]

void xalanc::XalanSourceTreeElement::setParent ( XalanSourceTreeDocumentFragment * theParent )

◆ setParent() [2/2]

void xalanc::XalanSourceTreeElement::setParent ( XalanSourceTreeElement * theParent )

inline

Definition at line 142 of file XalanSourceTreeElement.hpp.

◆ setPreviousSibling() [1/4]

void xalanc::XalanSourceTreeElement::setPreviousSibling ( XalanSourceTreeComment * thePreviousSibling )

◆ setPreviousSibling() [2/4]

void xalanc::XalanSourceTreeElement::setPreviousSibling ( XalanSourceTreeElement * thePreviousSibling )

◆ setPreviousSibling() [3/4]

void xalanc::XalanSourceTreeElement::setPreviousSibling ( XalanSourceTreeProcessingInstruction * thePreviousSibling )

◆ setPreviousSibling() [4/4]

void xalanc::XalanSourceTreeElement::setPreviousSibling ( XalanSourceTreeText * thePreviousSibling )

Member Data Documentation

◆ m_tagName

const XalanDOMString& xalanc::XalanSourceTreeElement::m_tagName

protected

Definition at line 214 of file XalanSourceTreeElement.hpp.

◆ s_emptyString

const XalanDOMString xalanc::XalanSourceTreeElement::s_emptyString

staticprotected

Definition at line 211 of file XalanSourceTreeElement.hpp.

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

xalanc/XalanSourceTree/XalanSourceTreeElement.hpp

Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XalanSourceTreeElement()

◆ ~XalanSourceTreeElement()

Member Function Documentation

◆ appendChildNode() [1/4]

◆ appendChildNode() [2/4]

◆ appendChildNode() [3/4]

◆ appendChildNode() [4/4]

◆ appendSiblingNode() [1/4]

◆ appendSiblingNode() [2/4]

◆ appendSiblingNode() [3/4]

◆ appendSiblingNode() [4/4]

◆ clearChildren()

◆ getAttributes()

◆ getChildNodes()

◆ getDocument()

◆ getFirstChild()

◆ getIndex()

◆ getLastChild()

◆ getLocalName()

◆ getMemoryManager()

◆ getNamespaceURI()

◆ getNextSibling()

◆ getNodeName()

◆ getNodeType()

◆ getNodeValue()

◆ getOwnerDocument()

◆ getParentNode()

◆ getPrefix()

◆ getPreviousSibling()

◆ getTagName()

◆ isIndexed()

◆ setIndex()

◆ setParent() [1/2]

◆ setParent() [2/2]

◆ setPreviousSibling() [1/4]

◆ setPreviousSibling() [2/4]

◆ setPreviousSibling() [3/4]

◆ setPreviousSibling() [4/4]

Member Data Documentation

◆ m_tagName

◆ s_emptyString