⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
gnu.xml.dom

Class DomEntity

java.lang.Object
|
+--gnu.xml.dom.DomNode
   |
   +--gnu.xml.dom.DomExtern
      |
      +--gnu.xml.dom.DomEntity

All Implemented Interfaces:
java.lang.Cloneable, Entity, DocumentEvent, EventTarget, Node, NodeList


public class DomEntity
extends DomExtern
implements Entity

"Entity" implementation. This is a non-core DOM class, supporting the "XML" feature. There are two types of entities, neither of which works particularly well in this API:

Unparsed Entities
Since ENTITY/ENTITIES attributes, the only legal use of unparsed entities in XML, can't be detected with DOM, there isn't much point in trying to use unparsed entities in DOM applications. (XML Linking is working to provide a better version of this functionality.)
Parsed Entities
While the DOM specification permits nodes for parsed entities to have a readonly set of children, this is not required and there is no portable way to provide such children. This implementation currently does not permit children to be added to Entities. There are related issues with the use of EntityReference nodes.

In short, avoid using this DOM functionality.

Author:
David Brownell
See Also:
DomDoctype
DomEntityReference
DomNotation

Constructor Summary

DomEntity(Document owner, java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notation)

Constructs an Entity node associated with the specified document, with the specified descriptive data.

Method Summary

short

getNodeType()

DOM L1 Returns the constant ENTITY_NODE.

java.lang.String

getNotationName()

DOM L1 Returns the NOTATION identifier associated with this entity, if any.

Constructor Details

DomEntity

protected DomEntity(Document owner, java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notation)

Constructs an Entity node associated with the specified document, with the specified descriptive data.

This constructor should only be invoked by a DomDoctype as part of its declareEntity functionality, or through a subclass which is similarly used in a "Sub-DOM" style layer.

Parameters:
owner - The document with which this entity is associated
name - Name of this entity
publicId - If non-null, provides the entity's PUBLIC identifier
systemId - Provides the entity's SYSTEM identifier (URI)
notation - If non-null, provides the unparsed entity's notation.

Method Details

getNodeType

public final short getNodeType()

DOM L1 Returns the constant ENTITY_NODE.


getNotationName

public final String getNotationName()

DOM L1 Returns the NOTATION identifier associated with this entity, if any.