Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

skNode Class Reference

This class describes a node within an XML document hierarchy. More...

#include <skNode.h>

Inheritance diagram for skNode:

skElement skTextNode skCDataNode List of all members.

Public Types

enum  NodeType
 This enumeration is used to distinguish between different types of node in a document.


Public Methods

virtual skString getNodeValue () const
 This method returns the "value" of a node.

virtual void setNodeValue (const skString &s)
 This method sets the "value" of the node.

virtual NodeType getNodeType () const=0
 This abstract virtual function returns the type of this node.

virtual skNode * clone ()=0
 This abstract virtual function requests that the node create a copy of itself.

virtual skString toString () const=0
 This abstract virtual function writes a textual representation of this node and its children to a string.

virtual void write (skOutputDestination &out) const=0
 This abstract virtual function writes a textual representation of this node and its children to the given destination.

void addRef ()
 Increments the reference count for this node.

void deRef ()
 Decrements the reference count for this node.

void setParent (skElement *parent)
 Sets the owning element.

skElementgetParent ()
 Returns the owning element.


Static Public Methods

skString escapeXMLDelimiters (const skString &text)
 This static method searches the given text for characters which must be "escaped" in an XML document.


Protected Methods

 skNode ()
 Blank constructor.


Protected Attributes

skElementm_Parent
 Pointer to the parent Element.


Detailed Description

This class describes a node within an XML document hierarchy.

It is part of the classes used in the Simkin XML DOM (Document Object Model)


Member Function Documentation

virtual skNode* skNode::clone   [pure virtual]
 

This abstract virtual function requests that the node create a copy of itself.

How this is done depends on the actual class of the node.

Returns:
a new node which is a clone of this one. A "deep" copy is performed.

Implemented in skCDataNode, skElement, and skTextNode.

void skNode::deRef  
 

Decrements the reference count for this node.

When this reaches zero, the node deletes itself

virtual NodeType skNode::getNodeType   const [pure virtual]
 

This abstract virtual function returns the type of this node.

It will be one of the NodeType values

Returns:
a NodeType value indicating the class to which this node belongs

Implemented in skCDataNode, skElement, and skTextNode.

skString skNode::getNodeValue   const [virtual]
 

This method returns the "value" of a node.

Typically this would be the text for a text or cdata node.

Returns:
returns a string. By default this is an empty string.

Reimplemented in skTextNode.

void skNode::setNodeValue const skString   s [virtual]
 

This method sets the "value" of the node.

Typically this would be the text for a text or cdata node. For other nodes, this does nothing.

Parameters:
s - the new value

Reimplemented in skTextNode.

virtual skString skNode::toString   const [pure virtual]
 

This abstract virtual function writes a textual representation of this node and its children to a string.

Returns:
the string containing the node

Implemented in skElement, and skTextNode.

virtual void skNode::write skOutputDestination   out const [pure virtual]
 

This abstract virtual function writes a textual representation of this node and its children to the given destination.

Parameters:
out - the destination to write to

Implemented in skCDataNode, skElement, and skTextNode.


The documentation for this class was generated from the following files:
Generated on Thu Jan 23 15:25:39 2003 for Simkin by doxygen1.3-rc1