Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Member Functions | Static Public Member Functions | List of all members
XalanSourceTreeComment Class Reference

#include <XalanSourceTreeComment.hpp>

Inherits XalanComment.

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 XalanDOMStringgetNodeName () const
 Gets the name of this node, depending on its type. More...
 
virtual const XalanDOMStringgetNodeValue () 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 XalanNodegetParentNode () const
 Gets the parent of this node. More...
 
virtual const XalanNodeListgetChildNodes () const
 Gets a XalanNodeList that contains all children of this node. More...
 
virtual XalanNodegetFirstChild () const
 Gets the first child of this node. More...
 
virtual XalanNodegetLastChild () const
 Gets the last child of this node. More...
 
virtual XalanNodegetPreviousSibling () const
 Gets the node immediately preceding this node. More...
 
virtual XalanNodegetNextSibling () const
 Gets the node immediately following this node. More...
 
virtual const XalanNamedNodeMapgetAttributes () const
 Gets a XalanNamedNodeMap containing the attributes of this node (if it is an XalanElement) or a null pointer otherwise. More...
 
virtual XalanDocumentgetOwnerDocument () const
 Gets the XalanDocument object associated with this node. More...
 
virtual const XalanDOMStringgetNamespaceURI () const
 Get the namespace URI of this node. More...
 
virtual const XalanDOMStringgetPrefix () const
 Get the namespace prefix of this node. More...
 
virtual const XalanDOMStringgetLocalName () 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 XalanDOMStringgetData () 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 XalanComment
 XalanComment ()
 
virtual ~XalanComment ()
 
- Public Member Functions inherited from XalanCharacterData
 XalanCharacterData ()
 
virtual ~XalanCharacterData ()
 
- Public Member Functions inherited from 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 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 XalanComment
 XalanComment (const XalanComment &theSource)
 
XalanCommentoperator= (const XalanComment &theSource)
 
bool operator== (const XalanComment &theRHS) const
 
- Protected Member Functions inherited from XalanCharacterData
 XalanCharacterData (const XalanCharacterData &theSource)
 
XalanCharacterDataoperator= (const XalanCharacterData &theSource)
 
bool operator== (const XalanCharacterData &theRHS) const
 
- Protected Member Functions inherited from XalanNode
 XalanNode (const XalanNode &theSource)
 
XalanNodeoperator= (const XalanNode &theSource)
 
bool operator== (const XalanNode &theRHS) const
 

Detailed Description

Definition at line 47 of file XalanSourceTreeComment.hpp.

Constructor & Destructor Documentation

◆ XalanSourceTreeComment()

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

Constructor.

Parameters
theDataThe text data of the node.
theOwnerDocumentThe owner document of the comment node.
theParentNodeThe parent node, if any.
thePreviousSiblingThe previous sibling, if any.
theNextSiblingThe next sibling, if any.
theIndexThe document-order index of the node.

◆ ~XalanSourceTreeComment()

virtual XalanSourceTreeComment::~XalanSourceTreeComment ( )
virtual

Member Function Documentation

◆ appendSiblingNode() [1/4]

void XalanSourceTreeComment::appendSiblingNode ( XalanSourceTreeComment theSibling)

◆ appendSiblingNode() [2/4]

void XalanSourceTreeComment::appendSiblingNode ( XalanSourceTreeElement theSibling)

◆ appendSiblingNode() [3/4]

void XalanSourceTreeComment::appendSiblingNode ( XalanSourceTreeProcessingInstruction theSibling)

◆ appendSiblingNode() [4/4]

void XalanSourceTreeComment::appendSiblingNode ( XalanSourceTreeText theSibling)

◆ getAttributes()

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

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

Implements XalanComment.

◆ getChildNodes()

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

◆ getData()

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

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

Implements XalanComment.

◆ getFirstChild()

virtual XalanNode* XalanSourceTreeComment::getFirstChild ( ) const
virtual

Gets the first child of this node.

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

Implements XalanComment.

◆ getIndex()

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

◆ getLastChild()

virtual XalanNode* XalanSourceTreeComment::getLastChild ( ) const
virtual

Gets the last child of this node.

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

Implements XalanComment.

◆ getLocalName()

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

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

Implements XalanComment.

◆ getNamespaceURI()

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

Get the namespace URI of this node.

Implements XalanComment.

◆ getNextSibling()

virtual XalanNode* XalanSourceTreeComment::getNextSibling ( ) const
virtual

Gets the node immediately following this node.

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

Implements XalanComment.

◆ getNodeName()

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

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

Implements XalanComment.

◆ getNodeType()

virtual NodeType XalanSourceTreeComment::getNodeType ( ) const
virtual

An enum value representing the type of the underlying object.

Implements XalanComment.

◆ getNodeValue()

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

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

Implements XalanComment.

◆ getOwnerDocument()

virtual XalanDocument* XalanSourceTreeComment::getOwnerDocument ( ) const
virtual

Gets the XalanDocument object associated with this node.

This may be a null pointer.

Implements XalanComment.

◆ getParentNode()

virtual XalanNode* XalanSourceTreeComment::getParentNode ( ) const
virtual

Gets the parent of this node.

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

Implements XalanComment.

◆ getPrefix()

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

Get the namespace prefix of this node.

Implements XalanComment.

◆ getPreviousSibling()

virtual XalanNode* XalanSourceTreeComment::getPreviousSibling ( ) const
virtual

Gets the node immediately preceding this node.

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

Implements XalanComment.

◆ initialize()

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

Perform static initialization.

See class XalanSourceTreeInit.

◆ isIndexed()

virtual bool XalanSourceTreeComment::isIndexed ( ) const
virtual

Determine if the document is node-order indexed.

Returns
true if the document is indexed, otherwise false.

Implements XalanComment.

◆ setIndex()

void XalanSourceTreeComment::setIndex ( IndexType  theIndex)
inline

Definition at line 170 of file XalanSourceTreeComment.hpp.

◆ setParent() [1/2]

void XalanSourceTreeComment::setParent ( XalanSourceTreeElement theParent)

◆ setParent() [2/2]

void XalanSourceTreeComment::setParent ( XalanSourceTreeDocumentFragment theParent)

◆ setPreviousSibling() [1/4]

void XalanSourceTreeComment::setPreviousSibling ( XalanSourceTreeComment thePreviousSibling)

◆ setPreviousSibling() [2/4]

void XalanSourceTreeComment::setPreviousSibling ( XalanSourceTreeElement thePreviousSibling)

◆ setPreviousSibling() [3/4]

void XalanSourceTreeComment::setPreviousSibling ( XalanSourceTreeProcessingInstruction thePreviousSibling)

◆ setPreviousSibling() [4/4]

void XalanSourceTreeComment::setPreviousSibling ( XalanSourceTreeText thePreviousSibling)

◆ terminate()

static void XalanSourceTreeComment::terminate ( )
static

Perform static shut down.

See class XalanSourceTreeInit.


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.

Xalan-C++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo