xalanc::XalanSourceTreeComment Class Reference

#include <xalanc/XalanSourceTree/XalanSourceTreeComment.hpp>

Inheritance diagram for xalanc::XalanSourceTreeComment:

Collaboration diagram for xalanc::XalanSourceTreeComment:

Public Member Functions
	XalanSourceTreeComment (const XalanDOMString &theData, XalanSourceTreeDocument *theOwnerDocument, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0, IndexType theIndex=0)
	Constructor. More...
virtual	~XalanSourceTreeComment ()
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 XalanNodeList 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
	Gets a XalanNamedNodeMap containing the attributes of this node (if it is an XalanElement) or a null pointer otherwise. More...
virtual XalanDocument *	getOwnerDocument () const
	Gets the XalanDocument object associated with this node. More...
virtual const XalanDOMString &	getNamespaceURI () const
	Get the namespace URI of this node. More...
virtual const XalanDOMString &	getPrefix () const
	Get the namespace prefix of this node. More...
virtual const XalanDOMString &	getLocalName () const
	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 &	getData () const
	Returns the character data of the node that implements this interface. More...
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	setIndex (IndexType theIndex)
Public Member Functions inherited from xalanc::XalanComment
	XalanComment ()
virtual	~XalanComment ()
Public Member Functions inherited from xalanc::XalanCharacterData
	XalanCharacterData ()
virtual	~XalanCharacterData ()
Public Member Functions inherited from xalanc::XalanNode
	XalanNode ()
virtual	~XalanNode ()

Static Public Member Functions
static void	initialize (MemoryManager &theManager)
	Perform static initialization. More...
static void	terminate ()
	Perform static shut down. More...

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::XalanComment
	XalanComment (const XalanComment &theSource)
XalanComment &	operator= (const XalanComment &theSource)
bool	operator== (const XalanComment &theRHS) const
Protected Member Functions inherited from xalanc::XalanCharacterData
	XalanCharacterData (const XalanCharacterData &theSource)
XalanCharacterData &	operator= (const XalanCharacterData &theSource)
bool	operator== (const XalanCharacterData &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 47 of file XalanSourceTreeComment.hpp.

Constructor & Destructor Documentation

XalanSourceTreeComment()

xalanc::XalanSourceTreeComment::XalanSourceTreeComment	(	const XalanDOMString &	theData,
		XalanSourceTreeDocument *	theOwnerDocument,
		XalanNode *	theParentNode = 0,
		XalanNode *	thePreviousSibling = 0,
		XalanNode *	theNextSibling = 0,
		IndexType	theIndex = 0
	)

Constructor.

Parameters

theData	The text data of the node.
theOwnerDocument	The owner document of the comment node.
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.

~XalanSourceTreeComment()

virtual xalanc::XalanSourceTreeComment::~XalanSourceTreeComment ( )

virtual

Member Function Documentation

appendSiblingNode() [1/4]

void xalanc::XalanSourceTreeComment::appendSiblingNode

(

XalanSourceTreeComment *

theSibling

)

appendSiblingNode() [2/4]

void xalanc::XalanSourceTreeComment::appendSiblingNode

(

XalanSourceTreeElement *

theSibling

)

appendSiblingNode() [3/4]

void xalanc::XalanSourceTreeComment::appendSiblingNode

(

XalanSourceTreeProcessingInstruction *

theSibling

)

appendSiblingNode() [4/4]

void xalanc::XalanSourceTreeComment::appendSiblingNode

(

XalanSourceTreeText *

theSibling

)

getAttributes()

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

virtual

Gets a XalanNamedNodeMap containing the attributes of this node (if it is an XalanElement) or a null pointer otherwise.

Implements xalanc::XalanComment.

getChildNodes()

virtual const XalanNodeList* xalanc::XalanSourceTreeComment::getChildNodes ( ) const

virtual

Gets a XalanNodeList that contains all children of this node.

If there are no children, this is a XalanNodeList containing no nodes.

Implements xalanc::XalanComment.

getData()

virtual const XalanDOMString& xalanc::XalanSourceTreeComment::getData ( ) const

virtual

Returns the character data of the node that implements this interface.

Implements xalanc::XalanComment.

getFirstChild()

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

virtual

Gets the first child of this node.

If there is no such node, this returns a null pointer.

Implements xalanc::XalanComment.

getIndex()

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

getLastChild()

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

virtual

Gets the last child of this node.

If there is no such node, this returns a null pointer.

Implements xalanc::XalanComment.

getLocalName()

virtual const XalanDOMString& xalanc::XalanSourceTreeComment::getLocalName ( ) const

virtual

Returns the local part of the qualified name of this node.

Implements xalanc::XalanComment.

getNamespaceURI()

virtual const XalanDOMString& xalanc::XalanSourceTreeComment::getNamespaceURI ( ) const

virtual

Get the namespace URI of this node.

Implements xalanc::XalanComment.

getNextSibling()

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

virtual

Gets the node immediately following this node.

If there is no such node, this returns a null pointer.

Implements xalanc::XalanComment.

getNodeName()

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

virtual

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

Implements xalanc::XalanComment.

getNodeType()

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

virtual

An enum value representing the type of the underlying object.

Implements xalanc::XalanComment.

getNodeValue()

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

virtual

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

Implements xalanc::XalanComment.

getOwnerDocument()

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

virtual

Gets the XalanDocument object associated with this node.

This may be a null pointer.

Implements xalanc::XalanComment.

getParentNode()

virtual XalanNode* xalanc::XalanSourceTreeComment::getParentNode ( ) const

virtual

Gets the parent of this node.

If there is no such node, this returns a null pointer.

Implements xalanc::XalanComment.

getPrefix()

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

virtual

Get the namespace prefix of this node.

Implements xalanc::XalanComment.

getPreviousSibling()

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

virtual

Gets the node immediately preceding this node.

If there is no such node, this returns a null pointer.

Implements xalanc::XalanComment.

initialize()

static void xalanc::XalanSourceTreeComment::initialize ( MemoryManager &  theManager )

static

Perform static initialization.

See class XalanSourceTreeInit.

isIndexed()

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

virtual

Determine if the document is node-order indexed.

Returns

true if the document is indexed, otherwise false.

Implements xalanc::XalanComment.

setIndex()

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

inline

Definition at line 170 of file XalanSourceTreeComment.hpp.

setParent() [1/2]

void xalanc::XalanSourceTreeComment::setParent

(

XalanSourceTreeDocumentFragment *

theParent

)

setParent() [2/2]

void xalanc::XalanSourceTreeComment::setParent

(

XalanSourceTreeElement *

theParent

)

setPreviousSibling() [1/4]

void xalanc::XalanSourceTreeComment::setPreviousSibling

(

XalanSourceTreeComment *

thePreviousSibling

)

setPreviousSibling() [2/4]

void xalanc::XalanSourceTreeComment::setPreviousSibling

(

XalanSourceTreeElement *

thePreviousSibling

)

setPreviousSibling() [3/4]

void xalanc::XalanSourceTreeComment::setPreviousSibling

(

XalanSourceTreeProcessingInstruction *

thePreviousSibling

)

setPreviousSibling() [4/4]

void xalanc::XalanSourceTreeComment::setPreviousSibling

(

XalanSourceTreeText *

thePreviousSibling

)

terminate()

static void xalanc::XalanSourceTreeComment::terminate ( )

static

Perform static shut down.

See class XalanSourceTreeInit.

---

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

• xalanc/XalanSourceTree/XalanSourceTreeComment.hpp