API Docs for SAX and DOM                 DOM_Entity Class Reference This interface represents an entity, either parsed or unparsed, in an XML document. More... #include <DOM_Entity.hpp> Inheritance diagram for DOM_Entity [legend]Collaboration diagram for DOM_Entity: [legend]List of all members. Public Methods Constructors and assignment operator   DOM_Entity ()   Default constructor for DOM_Entity.   DOM_Entity (const DOM_Entity &other)   Copy constructor. More... DOM_Entity&  operator= (const DOM_Entity &other)   Assignment operator. More... DOM_Entity&  operator= (const DOM_NullPtr *val)   Assignment operator. More... Destructor.   ~DOM_Entity ()   Destructor for DOM_Entity. Get functions. DOMString  getPublicId () const   The public identifier associated with the entity, if specified. More... DOMString  getSystemId () const   The system identifier associated with the entity, if specified. More... DOMString  getNotationName () const   For unparsed entities, the name of the notation for the entity. More... DOM_Node  getFirstChild () const   Gets the first child of this node. More... DOM_Node  getLastChild () const   Gets the last child of this node. More... DOM_NodeList  getChildNodes () const   Gets a NodeList that contains all children of this node. More... bool  hasChildNodes () const   This is a convenience method to allow easy determination of whether a node has any children. More... DOM_Node  getPreviousSibling () const   Gets the node immediately preceding this node. More... DOM_Node  getNextSibling () const   Gets the node immediately following this node. More... Protected Methods   DOM_Entity (EntityImpl *impl) Friends class   DOM_Document Detailed Description This interface represents an entity, either parsed or unparsed, in an XML document. Note that this models the entity itself not the entity declaration. Entity declaration modeling has been left for a later Level of the DOM specification. The nodeName attribute that is inherited from Node contains the name of the entity. An XML processor may choose to completely expand entities before the structure model is passed to the DOM; in this case there will be no EntityReference nodes in the document tree. Note: the first release of this parser does not create entity nodes when reading an XML document. Entities may be programatically created using DOM_Document::createEntity(). Constructor & Destructor Documentation DOM_Entity::DOM_Entity ( )   Default constructor for DOM_Entity. DOM_Entity::DOM_Entity ( const DOM_Entity & other )   Copy constructor. Parameters: other   The object to be copied. DOM_Entity::~DOM_Entity ( )   Destructor for DOM_Entity. DOM_Entity::DOM_Entity ( EntityImpl * impl ) [protected] Member Function Documentation DOM_NodeList DOM_Entity::getChildNodes ( ) const   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. Reimplemented from DOM_Node. DOM_Node DOM_Entity::getFirstChild ( ) const   Gets the first child of this node. If there is no such node, this returns null. Reimplemented from DOM_Node. DOM_Node DOM_Entity::getLastChild ( ) const   Gets the last child of this node. If there is no such node, this returns null. Reimplemented from DOM_Node. DOM_Node DOM_Entity::getNextSibling ( ) const   Gets the node immediately following this node. If there is no such node, this returns null. Reimplemented from DOM_Node. DOMString DOM_Entity::getNotationName ( ) const   For unparsed entities, the name of the notation for the entity. For parsed entities, this is null. DOM_Node DOM_Entity::getPreviousSibling ( ) const   Gets the node immediately preceding this node. If there is no such node, this returns null. Reimplemented from DOM_Node. DOMString DOM_Entity::getPublicId ( ) const   The public identifier associated with the entity, if specified. If the public identifier was not specified, this is null. DOMString DOM_Entity::getSystemId ( ) const   The system identifier associated with the entity, if specified. If the system identifier was not specified, this is null. bool DOM_Entity::hasChildNodes ( ) const   This is a convenience method to allow easy determination of whether a node has any children. Returns: true if the node has any children, false if the node has no children. Reimplemented from DOM_Node. DOM_Entity & DOM_Entity::operator= ( const DOM_NullPtr * val )   Assignment operator. This overloaded variant is provided for the sole purpose of setting a DOM_Node reference variable to zero. Nulling out a reference variable in this way will decrement the reference count on the underlying Node object that the variable formerly referenced. This effect is normally obtained when reference variable goes out of scope, but zeroing them can be useful for global instances, or for local instances that will remain in scope for an extended time, when the storage belonging to the underlying node needs to be reclaimed. Parameters: val.   Only a value of 0, or null, is allowed. Reimplemented from DOM_Node. DOM_Entity & DOM_Entity::operator= ( const DOM_Entity & other )   Assignment operator. Parameters: other   The object to be copied. Friends And Related Function Documentation class DOM_Document [friend]   Reimplemented from DOM_Node. The documentation for this class was generated from the following file: DOM_Entity.hpp

Copyright © 2000 The Apache Software Foundation. All Rights Reserved.