Logo Search packages:      
Sourcecode: lib-dom-java version File versions  Download package

org::w3c::dom::Entity Interface Reference

Inheritance diagram for org::w3c::dom::Entity:

org::w3c::dom::Node

List of all members.


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.

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 Entity node's child list represents the structure of that replacement text. Otherwise, the child list is empty.

The resolution of the children of the Entity (the replacement value) may be lazily evaluated; actions by the user (such as calling the childNodes method on the Entity Node) are assumed to trigger the evaluation.

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

An Entity node does not have any parent.

Definition at line 40 of file Entity.java.


Public Member Functions

Node appendChild (Node newChild) throws DOMException
Node cloneNode (boolean deep)
NamedNodeMap getAttributes ()
NodeList getChildNodes ()
Node getFirstChild ()
Node getLastChild ()
Node getNextSibling ()
String getNodeName ()
short getNodeType ()
String getNodeValue () throws DOMException
String getNotationName ()
Document getOwnerDocument ()
Node getParentNode ()
Node getPreviousSibling ()
String getPublicId ()
String getSystemId ()
boolean hasChildNodes ()
Node insertBefore (Node newChild, Node refChild) throws DOMException
Node removeChild (Node oldChild) throws DOMException
Node replaceChild (Node newChild, Node oldChild) throws DOMException
void setNodeValue (String nodeValue) throws DOMException

Static Public Attributes

static final short ATTRIBUTE_NODE = 2
static final short CDATA_SECTION_NODE = 4
static final short COMMENT_NODE = 8
static final short DOCUMENT_FRAGMENT_NODE = 11
static final short DOCUMENT_NODE = 9
static final short DOCUMENT_TYPE_NODE = 10
static final short ELEMENT_NODE = 1
static final short ENTITY_NODE = 6
static final short ENTITY_REFERENCE_NODE = 5
static final short NOTATION_NODE = 12
static final short PROCESSING_INSTRUCTION_NODE = 7
static final short TEXT_NODE = 3

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

Generated by  Doxygen 1.6.0   Back to index