XMLParserItf Interface CATIDOMEntity

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIDOMEntity

Interface to represent an entity, either parsed or unparsed, in an XML document.
Note that this models the entity itself not the entity declaration. declaration modeling has been left for a later Level of the DOM specification.

The attribute that is inherited from 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 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 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 nodes; if a user wants to make changes to the contents of an , every related node has to be replaced in the structure model by a clone of the 's contents, and then the desired changes must be made to each of those clones instead. nodes and all their descendants are readonly.

An node does not have any parent. If the entity contains an unbound namespace prefix, the of the corresponding node in the node subtree returns an empty . The same is true for nodes that refer to this entity, when they are created using the method of the 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.


Method Index


o GetNotationName(CATUnicodeString&)
For unparsed entities, retrives the name of the notation for the entity.
o GetPublicId(CATUnicodeString&)
Retrives the public identifier associated with the entity, if specified.
o GetSystemId(CATUnicodeString&)
Retrives the system identifier associated with the entity, if specified.

Methods


o GetNotationName
public virtual GetNotationName( oNotationName)
For unparsed entities, retrives the name of the notation for the entity. For parsed entities, this is an empty .
Parameters:
oSystemId
the name of the notation for the entity
o GetPublicId
public virtual GetPublicId( oPublicId)
Retrives the public identifier associated with the entity, if specified. If the public identifier was not specified, this an empty .
Parameters:
oPublicId
the public identifier associated with the entity
o GetSystemId
public virtual GetSystemId( oSystemId)
Retrives the system identifier associated with the entity, if specified. If the system identifier was not specified, this is an empty .
Parameters:
oSystemId
the system identifier associated with the entity

This object is included in the file: CATIDOMEntity.h
If needed, your Imakefile.mk should include the module: CatXmlItfExt

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.