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

#include <xalanc/XalanDOM/XalanElement.hpp>

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

Public Member Functions

 XalanElement ()
 
virtual ~XalanElement ()
 
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 NodeList 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 NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. More...
 
virtual XalanDocumentgetOwnerDocument () const =0
 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 =0
 Determine if the document is node-order indexed. More...
 
virtual IndexType getIndex () const =0
 Get the node's index. More...
 
virtual const XalanDOMStringgetTagName () const =0
 The name of the element. More...
 
- Public Member Functions inherited from xalanc::XalanNode
 XalanNode ()
 
virtual ~XalanNode ()
 

Protected Member Functions

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

Constructor & Destructor Documentation

◆ XalanElement() [1/2]

xalanc::XalanElement::XalanElement ( )

◆ ~XalanElement()

virtual xalanc::XalanElement::~XalanElement ( )
virtual

◆ XalanElement() [2/2]

xalanc::XalanElement::XalanElement ( const XalanElement theSource)
protected

Member Function Documentation

◆ getAttributes()

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

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeElement, xalanc::XercesElementBridge, xalanc::XercesElementWrapper, xalanc::XalanSourceTreeElementA, and xalanc::XalanSourceTreeElementNA.

◆ getChildNodes()

virtual const XalanNodeList* xalanc::XalanElement::getChildNodes ( ) const
pure virtual

Gets a NodeList that contains all children of this node.

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

Implements xalanc::XalanNode.

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ getFirstChild()

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

Gets the first child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanNode.

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ getIndex()

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

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ getLastChild()

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

Gets the last child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanNode.

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ getLocalName()

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

Implemented in xalanc::XalanSourceTreeElement, xalanc::XercesElementBridge, xalanc::XercesElementWrapper, xalanc::XalanSourceTreeElementA, xalanc::XalanSourceTreeElementANS, xalanc::XalanSourceTreeElementNA, and xalanc::XalanSourceTreeElementNANS.

◆ getNamespaceURI()

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

Implemented in xalanc::XalanSourceTreeElement, xalanc::XercesElementBridge, xalanc::XercesElementWrapper, xalanc::XalanSourceTreeElementA, xalanc::XalanSourceTreeElementANS, xalanc::XalanSourceTreeElementNA, and xalanc::XalanSourceTreeElementNANS.

◆ getNextSibling()

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

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements xalanc::XalanNode.

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ getNodeName()

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

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeElement, xalanc::XercesElementBridge, and xalanc::XercesElementWrapper.

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

◆ getNodeType()

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

An enum value representing the type of the underlying object.

Implements xalanc::XalanNode.

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ getNodeValue()

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

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

Implements xalanc::XalanNode.

Implemented in xalanc::XalanSourceTreeElement, xalanc::XercesElementBridge, and xalanc::XercesElementWrapper.

◆ getOwnerDocument()

virtual XalanDocument* xalanc::XalanElement::getOwnerDocument ( ) const
pure 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 xalanc::XalanNode.

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ getParentNode()

virtual XalanNode* xalanc::XalanElement::getParentNode ( ) const
pure 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 xalanc::XalanNode.

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ getPrefix()

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

◆ getPreviousSibling()

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

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements xalanc::XalanNode.

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ getTagName()

virtual const XalanDOMString& xalanc::XalanElement::getTagName ( ) const
pure 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.

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ isIndexed()

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

Determine if the document is node-order indexed.

Returns
true if the document is indexed, otherwise false.

Implements xalanc::XalanNode.

Implemented in xalanc::XercesElementBridge, xalanc::XalanSourceTreeElement, and xalanc::XercesElementWrapper.

◆ operator=()

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

◆ operator==()

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

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