| API Docs for SAX and DOM |

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

# DOMEntity Class Reference

This interface represents an entity, either parsed or unparsed, in an XML document. More...

`#include <DOMEntity.hpp>`

Inheritance diagram for DOMEntity

[legend]
Collaboration diagram for DOMEntity:

[legend]
List of all members.

## Public Methods

Destructor
virtual | ~DOMEntity ()
| Destructor.
Functions introduced in DOM Level 1
virtual const XMLCh* | getPublicId ()const=0
| The public identifier associated with the entity, if specified. More...
virtual const XMLCh* | getSystemId ()const=0
| The system identifier associated with the entity, if specified. More...
virtual const XMLCh* | getNotationName ()const=0
| For unparsed entities, the name of the notation for the entity. More...
Functions introduced in DOM Level 3.
virtual const XMLCh* | getActualEncoding ()const=0
| An attribute specifying the actual encoding of this entity, when it is an external parsed entity. More...
virtual void | setActualEncoding (const XMLCh *actualEncoding)=0
| An attribute specifying the actual encoding of this entity, when it is an external parsed entity. More...
virtual const XMLCh* | getEncoding ()const=0
| An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity. More...
virtual void | setEncoding (const XMLCh *encoding)=0
| An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity. More...
virtual const XMLCh* | getVersion ()const=0
| An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity. More...
virtual void | setVersion (const XMLCh *version)=0
| An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity. More...

## Protected Methods

Hidden constructors
| DOMEntity ()
| DOMEntity (const DOMEntity &)
DOMEntity& | operator= (const DOMEntity &)

## 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. `DOMEntity` declaration modeling has been left for a later Level of the DOM specification.

The `nodeName` attribute that is inherited from `DOMNode` 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 `DOMEntityReference` nodes in the document tree.

XML does not mandate that a non-validating XML processor read and process entity declarations made in the external subset or declared in external parameter entities. This means that parsed entities declared in the external subset need not be expanded by some classes of applications, and that the replacement value of the entity may not be available. When the replacement value is available, the corresponding `DOMEntity` node's child list represents the structure of that replacement text. Otherwise, the child list is empty.

The DOM Level 2 does not support editing `DOMEntity` nodes; if a user wants to make changes to the contents of an `DOMEntity`, every related `DOMEntityReference` node has to be replaced in the structure model by a clone of the `DOMEntity`'s contents, and then the desired changes must be made to each of those clones instead. `DOMEntity` nodes and all their descendants are readonly.

An `DOMEntity` node does not have any parent.If the entity contains an unbound namespace prefix, the `namespaceURI` of the corresponding node in the `DOMEntity` node subtree is `null`. The same is true for `DOMEntityReference` nodes that refer to this entity, when they are created using the `createEntityReference` method of the `DOMDocument` interface. The DOM Level 2 does not support any mechanism to resolve namespace prefixes.

See also the Document Object Model (DOM) Level 2 Core Specification.

Since:
  DOM Level 1

## Constructor & Destructor Documentation

DOMEntity::DOMEntity ( | )`[protected]`

DOMEntity::DOMEntity ( | const DOMEntity & )`[protected]`

DOMEntity::~DOMEntity ( | )`[virtual]`

| Destructor.

## Member Function Documentation

const XMLCh * DOMEntity::getActualEncoding ( | ) const`[pure virtual]`

An attribute specifying the actual encoding of this entity, when it is an external parsed entity.

This is `null` otherwise.

"Experimental - subject to change"

Since:
  DOM Level 3

const XMLCh * DOMEntity::getEncoding ( | ) const`[pure virtual]`

An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity.

This is `null` otherwise.

"Experimental - subject to change"

Since:
  DOM Level 3

const XMLCh * DOMEntity::getNotationName ( | ) const`[pure virtual]`

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

For parsed entities, this is `null`.

Since:
  DOM Level 1

const XMLCh * DOMEntity::getPublicId ( | ) const`[pure virtual]`

The public identifier associated with the entity, if specified.

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

Since:
  DOM Level 1

const XMLCh * DOMEntity::getSystemId ( | ) const`[pure virtual]`

The system identifier associated with the entity, if specified.

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

Since:
  DOM Level 1

const XMLCh * DOMEntity::getVersion ( | ) const`[pure virtual]`

An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity.

This is `null` otherwise.

"Experimental - subject to change"

Since:
  DOM Level 3

DOMEntity & DOMEntity::operator= ( | const DOMEntity & )`[protected]`

void DOMEntity::setActualEncoding ( | const XMLCh * actualEncoding )`[pure virtual]`

An attribute specifying the actual encoding of this entity, when it is an external parsed entity.

This is `null` otherwise.

"Experimental - subject to change"

Since:
  DOM Level 3

void DOMEntity::setEncoding ( | const XMLCh * encoding )`[pure virtual]`

An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity.

This is `null` otherwise.

"Experimental - subject to change"

Since:
  DOM Level 3

void DOMEntity::setVersion ( | const XMLCh * version )`[pure virtual]`

An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity.

This is `null` otherwise.

"Experimental - subject to change"

Since:
  DOM Level 3

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

- DOMEntity.hpp

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