http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback
Bug-Todo

Download
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

DOM_Notation Class Reference

This interface represents a notation declared in the DTD. More...

#include <DOM_Notation.hpp>

Inheritance diagram for DOM_Notation

Inheritance graph
[legend]
Collaboration diagram for DOM_Notation:

Collaboration graph
[legend]
List of all members.

Public Methods

Constructors and assignment operator
 DOM_Notation ()
 Default constructor for DOM_Notation. More...

 DOM_Notation (const DOM_Notation &other)
 Copy constructor. More...

DOM_Notation& operator= (const DOM_Notation &other)
 Assignment operator. More...

DOM_Notation& operator= (const DOM_NullPtr *val)
 Assignment operator. More...

Destructor.
 ~DOM_Notation ()
 Destructor for DOM_Notation. More...

Get functions.
DOMString getPublicId () const
 Get the public identifier of this notation. More...

DOMString getSystemId () const
 Get the system identifier of this notation. More...


Protected Methods

 DOM_Notation (NotationImpl *impl)

Friends

class  DOM_Document

Detailed Description

This interface represents a notation declared in the DTD.

A notation either declares, by name, the format of an unparsed entity (see section 4.7 of the XML 1.0 specification), or is used for formal declaration of Processing Instruction targets (see section 2.6 of the XML 1.0 specification). The nodeName attribute inherited from Node is set to the declared name of the notation.

The DOM Level 1 does not support editing Notation nodes; they are therefore readonly.

A Notation node does not have any parent.


Constructor & Destructor Documentation

DOM_Notation::DOM_Notation ( )
 

Default constructor for DOM_Notation.

The resulting object does not refer to an actual Notation node; it will compare == to 0, and is similar to a null object reference variable in Java. It may subsequently be assigned to refer to an actual Notation node.

New notation nodes are created by DOM_Document::createNotation().

DOM_Notation::DOM_Notation ( const DOM_Notation & other )
 

Copy constructor.

Creates a new DOM_Notation that refers to the same underlying node as the original. See also DOM_Node::clone(), which will copy the actual notation node, rather than just creating a new reference to the original node.

Parameters:
other   The object to be copied.

DOM_Notation::~DOM_Notation ( )
 

Destructor for DOM_Notation.

The object being destroyed is the reference object, not the underlying Notation node itself.

DOM_Notation::DOM_Notation ( NotationImpl * impl ) [protected]
 


Member Function Documentation

DOMString DOM_Notation::getPublicId ( ) const
 

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

DOMString DOM_Notation::getSystemId ( ) const
 

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

DOM_Notation & DOM_Notation::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_Notation & DOM_Notation::operator= ( const DOM_Notation & 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:


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