Xalan-C++ API Reference  1.12.0
Public Member Functions | Protected Member Functions | List of all members
xalanc::XalanComment Class Referenceabstract

#include <xalanc/XalanDOM/XalanComment.hpp>

Inheritance diagram for xalanc::XalanComment:
[legend]
Collaboration diagram for xalanc::XalanComment:
[legend]

Public Member Functions

 XalanComment ()
 
virtual ~XalanComment ()
 
virtual const XalanDOMStringgetNodeName () const =0
 Gets the name of this node, depending on its type. More...
 
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 XalanNodeList 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 XalanNamedNodeMap containing the attributes of this node (if it is an XalanElement) or a null pointer otherwise. More...
 
virtual XalanDocumentgetOwnerDocument () const =0
 Gets the XalanDocument object associated with this node. More...
 
virtual const XalanDOMStringgetNamespaceURI () const =0
 Get the namespace URI of this node. More...
 
virtual const XalanDOMStringgetPrefix () const =0
 Get the namespace prefix of this node. More...
 
virtual const XalanDOMStringgetLocalName () 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 const XalanDOMStringgetData () const =0
 Returns the character data of the node that implements this interface. More...
 
- Public Member Functions inherited from xalanc::XalanCharacterData
 XalanCharacterData ()
 
virtual ~XalanCharacterData ()
 
- Public Member Functions inherited from xalanc::XalanNode
 XalanNode ()
 
virtual ~XalanNode ()
 

Protected Member Functions

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

Constructor & Destructor Documentation

◆ XalanComment() [1/2]

xalanc::XalanComment::XalanComment ( )

◆ ~XalanComment()

virtual xalanc::XalanComment::~XalanComment ( )
virtual

◆ XalanComment() [2/2]

xalanc::XalanComment::XalanComment ( const XalanComment theSource)
protected

Member Function Documentation

◆ getAttributes()

virtual const XalanNamedNodeMap* xalanc::XalanComment::getAttributes ( ) const
pure virtual

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

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ getChildNodes()

virtual const XalanNodeList* xalanc::XalanComment::getChildNodes ( ) const
pure 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::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ getData()

virtual const XalanDOMString& xalanc::XalanComment::getData ( ) const
pure virtual

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

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

Referenced by xalanc::DOMServices::getNodeData().

◆ getFirstChild()

virtual XalanNode* xalanc::XalanComment::getFirstChild ( ) const
pure virtual

Gets the first child of this node.

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

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ getIndex()

virtual IndexType xalanc::XalanComment::getIndex ( ) const
pure 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::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ getLastChild()

virtual XalanNode* xalanc::XalanComment::getLastChild ( ) const
pure virtual

Gets the last child of this node.

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

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ getLocalName()

virtual const XalanDOMString& xalanc::XalanComment::getLocalName ( ) const
pure virtual

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

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ getNamespaceURI()

virtual const XalanDOMString& xalanc::XalanComment::getNamespaceURI ( ) const
pure virtual

Get the namespace URI of this node.

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ getNextSibling()

virtual XalanNode* xalanc::XalanComment::getNextSibling ( ) const
pure virtual

Gets the node immediately following this node.

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

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ getNodeName()

virtual const XalanDOMString& xalanc::XalanComment::getNodeName ( ) const
pure virtual

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

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XalanSourceTreeComment, xalanc::XercesCommentBridge, and xalanc::XercesCommentWrapper.

◆ getNodeType()

virtual NodeType xalanc::XalanComment::getNodeType ( ) const
pure virtual

An enum value representing the type of the underlying object.

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XalanSourceTreeComment, xalanc::XercesCommentBridge, and xalanc::XercesCommentWrapper.

◆ getNodeValue()

virtual const XalanDOMString& xalanc::XalanComment::getNodeValue ( ) const
pure virtual

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

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XalanSourceTreeComment, xalanc::XercesCommentBridge, and xalanc::XercesCommentWrapper.

◆ getOwnerDocument()

virtual XalanDocument* xalanc::XalanComment::getOwnerDocument ( ) const
pure virtual

Gets the XalanDocument object associated with this node.

This may be a null pointer.

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ getParentNode()

virtual XalanNode* xalanc::XalanComment::getParentNode ( ) const
pure virtual

Gets the parent of this node.

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

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XalanSourceTreeComment, xalanc::XercesCommentBridge, and xalanc::XercesCommentWrapper.

◆ getPrefix()

virtual const XalanDOMString& xalanc::XalanComment::getPrefix ( ) const
pure virtual

Get the namespace prefix of this node.

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ getPreviousSibling()

virtual XalanNode* xalanc::XalanComment::getPreviousSibling ( ) const
pure virtual

Gets the node immediately preceding this node.

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

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ isIndexed()

virtual bool xalanc::XalanComment::isIndexed ( ) const
pure virtual

Determine if the document is node-order indexed.

Returns
true if the document is indexed, otherwise false.

Implements xalanc::XalanCharacterData.

Implemented in xalanc::XercesCommentBridge, xalanc::XalanSourceTreeComment, and xalanc::XercesCommentWrapper.

◆ operator=()

XalanComment& xalanc::XalanComment::operator= ( const XalanComment theSource)
protected

◆ operator==()

bool xalanc::XalanComment::operator== ( const XalanComment theRHS) const
protected

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