Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
XalanSourceTreeElement Class Referenceabstract

#include <XalanSourceTreeElement.hpp>

Inherits XalanElement.

Inherited by XalanSourceTreeElementA, and XalanSourceTreeElementNA.

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 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 NodeList 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 =0
 Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. More...
 
virtual XalanDocumentgetOwnerDocument () const
 Gets the Document object associated with this node. More...
 
virtual const XalanDOMStringgetNamespaceURI () const =0
 Get the namespace URI of this node, or null if it is unspecified. More...
 
virtual const XalanDOMStringgetPrefix () const =0
 Get the namespace prefix of this node, or null if it is unspecified. More...
 
virtual const XalanDOMStringgetLocalName () 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 XalanDOMStringgetTagName () const
 The name of the element. More...
 
XalanSourceTreeDocumentgetDocument () 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 XalanElement
 XalanElement ()
 
virtual ~XalanElement ()
 
- Public Member Functions inherited from XalanNode
 XalanNode ()
 
virtual ~XalanNode ()
 

Protected Attributes

const XalanDOMStringm_tagName
 

Static Protected Attributes

static const XalanDOMString s_emptyString
 

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 XalanElement
 XalanElement (const XalanElement &theSource)
 
XalanElementoperator= (const XalanElement &theSource)
 
bool operator== (const XalanElement &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 46 of file XalanSourceTreeElement.hpp.

Constructor & Destructor Documentation

◆ XalanSourceTreeElement()

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

Constructor.

Parameters
theTagNameThe tag name of the element
theOwnerDocumentThe document that owns the instance
theAttributesAn array of pointers to the attribute instances for the element
theAttributeCountThe number of attributes.
theParentNodeThe parent node, if any.
thePreviousSiblingThe previous sibling, if any.
theNextSiblingThe next sibling, if any.
theIndexThe document-order index of the node.

◆ ~XalanSourceTreeElement()

virtual XalanSourceTreeElement::~XalanSourceTreeElement ( )
virtual

Member Function Documentation

◆ appendChildNode() [1/4]

void XalanSourceTreeElement::appendChildNode ( XalanSourceTreeComment theChild)

◆ appendChildNode() [2/4]

void XalanSourceTreeElement::appendChildNode ( XalanSourceTreeElement theChild)

◆ appendChildNode() [3/4]

void XalanSourceTreeElement::appendChildNode ( XalanSourceTreeProcessingInstruction theChild)

◆ appendChildNode() [4/4]

void XalanSourceTreeElement::appendChildNode ( XalanSourceTreeText theChild)

◆ appendSiblingNode() [1/4]

void XalanSourceTreeElement::appendSiblingNode ( XalanSourceTreeComment theSibling)

◆ appendSiblingNode() [2/4]

void XalanSourceTreeElement::appendSiblingNode ( XalanSourceTreeElement theSibling)

◆ appendSiblingNode() [3/4]

void XalanSourceTreeElement::appendSiblingNode ( XalanSourceTreeProcessingInstruction theSibling)

◆ appendSiblingNode() [4/4]

void XalanSourceTreeElement::appendSiblingNode ( XalanSourceTreeText theSibling)

◆ clearChildren()

void 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* XalanSourceTreeElement::getAttributes ( ) const
pure virtual

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

Implements XalanElement.

Implemented in XalanSourceTreeElementA, and XalanSourceTreeElementNA.

◆ getChildNodes()

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

◆ getDocument()

XalanSourceTreeDocument* XalanSourceTreeElement::getDocument ( ) const
inline

Definition at line 136 of file XalanSourceTreeElement.hpp.

◆ getFirstChild()

virtual XalanNode* XalanSourceTreeElement::getFirstChild ( ) const
virtual

Gets the first child of this node.

If there is no such node, this returns null.

Implements XalanElement.

◆ getIndex()

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

◆ getLastChild()

virtual XalanNode* XalanSourceTreeElement::getLastChild ( ) const
virtual

Gets the last child of this node.

If there is no such node, this returns null.

Implements XalanElement.

◆ getLocalName()

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

Implemented in XalanSourceTreeElementA, XalanSourceTreeElementANS, XalanSourceTreeElementNA, and XalanSourceTreeElementNANS.

◆ getMemoryManager()

MemoryManager& XalanSourceTreeElement::getMemoryManager ( )
inline

Definition at line 75 of file XalanSourceTreeElement.hpp.

◆ getNamespaceURI()

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

Implemented in XalanSourceTreeElementA, XalanSourceTreeElementANS, XalanSourceTreeElementNA, and XalanSourceTreeElementNANS.

◆ getNextSibling()

virtual XalanNode* XalanSourceTreeElement::getNextSibling ( ) const
virtual

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements XalanElement.

◆ getNodeName()

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

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

Implements XalanElement.

◆ getNodeType()

virtual NodeType XalanSourceTreeElement::getNodeType ( ) const
virtual

An enum value representing the type of the underlying object.

Implements XalanElement.

◆ getNodeValue()

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

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

Implements XalanElement.

◆ getOwnerDocument()

virtual XalanDocument* 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 XalanElement.

◆ getParentNode()

virtual XalanNode* 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 XalanElement.

◆ getPrefix()

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

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

Implements XalanElement.

Implemented in XalanSourceTreeElementA, XalanSourceTreeElementANS, XalanSourceTreeElementNA, and XalanSourceTreeElementNANS.

◆ getPreviousSibling()

virtual XalanNode* XalanSourceTreeElement::getPreviousSibling ( ) const
virtual

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements XalanElement.

◆ getTagName()

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

◆ isIndexed()

virtual bool XalanSourceTreeElement::isIndexed ( ) const
virtual

Determine if the document is node-order indexed.

Returns
true if the document is indexed, otherwise false.

Implements XalanElement.

◆ setIndex()

void XalanSourceTreeElement::setIndex ( IndexType  theIndex)
inline

Definition at line 187 of file XalanSourceTreeElement.hpp.

◆ setParent() [1/2]

void XalanSourceTreeElement::setParent ( XalanSourceTreeElement theParent)
inline

Definition at line 142 of file XalanSourceTreeElement.hpp.

◆ setParent() [2/2]

void XalanSourceTreeElement::setParent ( XalanSourceTreeDocumentFragment theParent)

◆ setPreviousSibling() [1/4]

void XalanSourceTreeElement::setPreviousSibling ( XalanSourceTreeComment thePreviousSibling)

◆ setPreviousSibling() [2/4]

void XalanSourceTreeElement::setPreviousSibling ( XalanSourceTreeElement thePreviousSibling)

◆ setPreviousSibling() [3/4]

void XalanSourceTreeElement::setPreviousSibling ( XalanSourceTreeProcessingInstruction thePreviousSibling)

◆ setPreviousSibling() [4/4]

void XalanSourceTreeElement::setPreviousSibling ( XalanSourceTreeText thePreviousSibling)

Member Data Documentation

◆ m_tagName

const XalanDOMString& XalanSourceTreeElement::m_tagName
protected

Definition at line 214 of file XalanSourceTreeElement.hpp.

◆ s_emptyString

const XalanDOMString XalanSourceTreeElement::s_emptyString
staticprotected

Definition at line 211 of file XalanSourceTreeElement.hpp.


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