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

#include <xalanc/XercesParserLiaison/XercesEntityWrapper.hpp>

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

Public Member Functions

 XercesEntityWrapper (const DOMEntityType *theXercesDOMEntity, const XercesWrapperNavigator &theNavigator)
 
virtual ~XercesEntityWrapper ()
 
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
 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
 Get the namespace URI of this node, or null if it is unspecified. More...
 
virtual const XalanDOMStringgetPrefix () const
 Get the namespace prefix of this node, or null if it is unspecified. 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 XalanDOMStringgetPublicId () const
 Get the public identifier of this notation. More...
 
virtual const XalanDOMStringgetSystemId () const
 Get the system identifier of this notation. More...
 
virtual const XalanDOMStringgetNotationName () const
 For unparsed entities, the name of the notation for the entity. More...
 
const DOMEntityTypegetXercesNode () const
 
- Public Member Functions inherited from xalanc::XalanEntity
 XalanEntity ()
 
virtual ~XalanEntity ()
 
- Public Member Functions inherited from xalanc::XalanNode
 XalanNode ()
 
virtual ~XalanNode ()
 

Static Public Member Functions

static XercesEntityWrappercreate (MemoryManager &theManager, const DOMEntityType *theXercesDOMEntity, const XercesWrapperNavigator &theNavigator)
 

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

Detailed Description

Definition at line 46 of file XercesEntityWrapper.hpp.

Constructor & Destructor Documentation

◆ XercesEntityWrapper()

xalanc::XercesEntityWrapper::XercesEntityWrapper ( const DOMEntityType theXercesDOMEntity,
const XercesWrapperNavigator theNavigator 
)

◆ ~XercesEntityWrapper()

virtual xalanc::XercesEntityWrapper::~XercesEntityWrapper ( )
virtual

Member Function Documentation

◆ create()

static XercesEntityWrapper* xalanc::XercesEntityWrapper::create ( MemoryManager &  theManager,
const DOMEntityType theXercesDOMEntity,
const XercesWrapperNavigator theNavigator 
)
static

◆ getAttributes()

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

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

Implements xalanc::XalanEntity.

◆ getChildNodes()

virtual const XalanNodeList* xalanc::XercesEntityWrapper::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. The content of the returned NodeList is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeList accessors; it is not a static snapshot of the content of the node. This is true for every NodeList, including the ones returned by the getElementsByTagName method.

Implements xalanc::XalanEntity.

◆ getFirstChild()

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

Gets the first child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanEntity.

◆ getIndex()

virtual IndexType xalanc::XercesEntityWrapper::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::XalanEntity.

◆ getLastChild()

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

Gets the last child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanEntity.

◆ getLocalName()

virtual const XalanDOMString& xalanc::XercesEntityWrapper::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::XalanEntity.

◆ getNamespaceURI()

virtual const XalanDOMString& xalanc::XercesEntityWrapper::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::XalanEntity.

◆ getNextSibling()

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

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements xalanc::XalanEntity.

◆ getNodeName()

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

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

Implements xalanc::XalanEntity.

◆ getNodeType()

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

An enum value representing the type of the underlying object.

Implements xalanc::XalanEntity.

◆ getNodeValue()

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

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

Implements xalanc::XalanEntity.

◆ getNotationName()

virtual const XalanDOMString& xalanc::XercesEntityWrapper::getNotationName ( ) const
virtual

For unparsed entities, the name of the notation for the entity.

For parsed entities, this is null.

Implements xalanc::XalanEntity.

◆ getOwnerDocument()

virtual XalanDocument* xalanc::XercesEntityWrapper::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::XalanEntity.

◆ getParentNode()

virtual XalanNode* xalanc::XercesEntityWrapper::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::XalanEntity.

◆ getPrefix()

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

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

Implements xalanc::XalanEntity.

◆ getPreviousSibling()

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

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements xalanc::XalanEntity.

◆ getPublicId()

virtual const XalanDOMString& xalanc::XercesEntityWrapper::getPublicId ( ) const
virtual

Get the public identifier of this notation.

If the public identifier was not specified, this is null.

Returns
Returns the public identifier of the notation

Implements xalanc::XalanEntity.

◆ getSystemId()

virtual const XalanDOMString& xalanc::XercesEntityWrapper::getSystemId ( ) const
virtual

Get the system identifier of this notation.

If the system identifier was not specified, this is null.

Returns
Returns the system identifier of the notation

Implements xalanc::XalanEntity.

◆ getXercesNode()

const DOMEntityType* xalanc::XercesEntityWrapper::getXercesNode ( ) const
inline

Definition at line 123 of file XercesEntityWrapper.hpp.

◆ isIndexed()

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

Determine if the document is node-order indexed.

Returns
true if the document is indexed, otherwise false.

Implements xalanc::XalanEntity.


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