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

#include <xalanc/XercesParserLiaison/XercesElementWrapper.hpp>

Inheritance diagram for xalanc::XercesElementWrapper:
xalanc::XalanElement xalanc::XalanNodeList xalanc::XalanNode

Public Member Functions

 XercesElementWrapper (const DOMElementType *theXercesElement, const XercesWrapperNavigator &theNavigator)
 
virtual ~XercesElementWrapper ()
 
virtual const XalanDOMString & getNodeName () const
 Gets the name of this node, depending on its type.
 
virtual const XalanDOMString & getNodeValue () const
 Gets the value of this node, depending on its type.
 
virtual NodeType getNodeType () const
 An enum value representing the type of the underlying object.
 
virtual XalanNode * getParentNode () const
 Gets the parent of this node.
 
virtual const XalanNodeList * getChildNodes () const
 Gets a NodeList that contains all children of this node.
 
virtual XalanNode * getFirstChild () const
 Gets the first child of this node.
 
virtual XalanNode * getLastChild () const
 Gets the last child of this node.
 
virtual XalanNode * getPreviousSibling () const
 Gets the node immediately preceding this node.
 
virtual XalanNode * getNextSibling () const
 Gets the node immediately following this node.
 
virtual const XalanNamedNodeMap * getAttributes () const
 Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
 
virtual XalanDocument * getOwnerDocument () const
 Gets the Document object associated with this node.
 
virtual const XalanDOMString & getNamespaceURI () const
 Get the namespace URI of this node, or null if it is unspecified.
 
virtual const XalanDOMString & getPrefix () const
 Get the namespace prefix of this node, or null if it is unspecified.
 
virtual const XalanDOMString & getLocalName () const
 Returns the local part of the qualified name of this node.
 
virtual bool isIndexed () const
 Determine if the document is node-order indexed.
 
virtual IndexType getIndex () const
 Get the node's index.
 
virtual const XalanDOMString & getTagName () const
 The name of the element.
 
const DOMElementType * getXercesNode () const
 Get the Xerces node this instance represent.
 
- Public Member Functions inherited from xalanc::XalanElement
 XalanElement ()
 
virtual ~XalanElement ()
 
- Public Member Functions inherited from xalanc::XalanNode
 XalanNode ()
 
virtual ~XalanNode ()
 

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
 
- Protected Member Functions inherited from xalanc::XalanElement
 XalanElement (const XalanElement &theSource)
 
XalanElement & operator= (const XalanElement &theSource)
 
bool operator== (const XalanElement &theRHS) const
 
- Protected Member Functions inherited from xalanc::XalanNode
 XalanNode (const XalanNode &theSource)
 
XalanNode & operator= (const XalanNode &theSource)
 
bool operator== (const XalanNode &theRHS) const
 

Detailed Description

Definition at line 49 of file XercesElementWrapper.hpp.

Constructor & Destructor Documentation

◆ XercesElementWrapper()

xalanc::XercesElementWrapper::XercesElementWrapper ( const DOMElementType *  theXercesElement,
const XercesWrapperNavigator &  theNavigator 
)

◆ ~XercesElementWrapper()

virtual xalanc::XercesElementWrapper::~XercesElementWrapper ( )
virtual

Member Function Documentation

◆ getAttributes()

virtual const XalanNamedNodeMap * xalanc::XercesElementWrapper::getAttributes ( ) const
virtual

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

Implements xalanc::XalanElement.

◆ getChildNodes()

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

◆ getFirstChild()

virtual XalanNode * xalanc::XercesElementWrapper::getFirstChild ( ) const
virtual

Gets the first child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanElement.

◆ getIndex()

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

◆ getLastChild()

virtual XalanNode * xalanc::XercesElementWrapper::getLastChild ( ) const
virtual

Gets the last child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanElement.

◆ getLocalName()

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

◆ getNamespaceURI()

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

◆ getNextSibling()

virtual XalanNode * xalanc::XercesElementWrapper::getNextSibling ( ) const
virtual

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements xalanc::XalanElement.

◆ getNodeName()

virtual const XalanDOMString & xalanc::XercesElementWrapper::getNodeName ( ) const
virtual

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

Implements xalanc::XalanElement.

◆ getNodeType()

virtual NodeType xalanc::XercesElementWrapper::getNodeType ( ) const
virtual

An enum value representing the type of the underlying object.

Implements xalanc::XalanElement.

◆ getNodeValue()

virtual const XalanDOMString & xalanc::XercesElementWrapper::getNodeValue ( ) const
virtual

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

Implements xalanc::XalanElement.

◆ getOwnerDocument()

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

◆ getParentNode()

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

◆ getPrefix()

virtual const XalanDOMString & xalanc::XercesElementWrapper::getPrefix ( ) const
virtual

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

Implements xalanc::XalanElement.

◆ getPreviousSibling()

virtual XalanNode * xalanc::XercesElementWrapper::getPreviousSibling ( ) const
virtual

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements xalanc::XalanElement.

◆ getTagName()

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

◆ getXercesNode()

const DOMElementType * xalanc::XercesElementWrapper::getXercesNode ( ) const
inline

Get the Xerces node this instance represent.

Returns
The Xerces node

Definition at line 120 of file XercesElementWrapper.hpp.

◆ isIndexed()

virtual bool xalanc::XercesElementWrapper::isIndexed ( ) const
virtual

Determine if the document is node-order indexed.

Returns
true if the document is indexed, otherwise false.

Implements xalanc::XalanElement.


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