org.apache.xerces.dom
public class EntityImpl extends ParentNode implements Entity
Note that this object models the actual entity, _not_ the entity declaration or the entity reference.
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 EntityReferences in the DOM tree.
Quoting the 10/01 DOM Proposal,
"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."I'm interpreting this as: It is the parser's responsibilty to call the non-DOM operation setReadOnly(true,true) after it constructs the Entity. Since the DOM explicitly decided not to deal with this, _any_ answer will involve a non-DOM operation, and this is the simplest solution.
Since: PR-DOM-Level-1-19980818.
Version: $Id: EntityImpl.java,v 1.26 2004/10/05 17:12:51 mrglavas Exp $
Field Summary | |
---|---|
protected String | baseURI base uri |
protected String | encoding Encoding |
protected String | inputEncoding Input Encoding |
protected String | name Entity name. |
protected String | notationName Notation name. |
protected String | publicId Public identifier. |
protected String | systemId System identifier. |
protected String | version Version |
Constructor Summary | |
---|---|
EntityImpl(CoreDocumentImpl ownerDoc, String name) Factory constructor. |
Method Summary | |
---|---|
Node | cloneNode(boolean deep) Clone node. |
String | getBaseURI()
Returns the absolute base URI of this node or null if the implementation
wasn't able to obtain an absolute URI. |
String | getInputEncoding()
An attribute specifying the encoding used for this entity at the tiome
of parsing, when it is an external parsed entity. |
String | getNodeName()
Returns the entity name |
short | getNodeType()
A short integer indicating what type of node this is. |
String | getNotationName()
Unparsed entities -- which contain non-XML data -- have a
"notation name" which tells applications how to deal with them.
|
String | getPublicId()
The public identifier associated with the entity. |
String | getSystemId()
The system identifier associated with the entity. |
String | getXmlEncoding()
DOM Level 3 WD - experimental
the encoding of this entity, when it is an external parsed entity. |
String | getXmlVersion()
DOM Level 3 WD - experimental
the version number of this entity, when it is an external parsed entity. |
void | setBaseURI(String uri) NON-DOM: set base uri |
void | setInputEncoding(String inputEncoding)
NON-DOM, used to set the input encoding. |
void | setNotationName(String name)
DOM Level 2: Unparsed entities -- which contain non-XML data -- have a
"notation name" which tells applications how to deal with them.
|
void | setPublicId(String id)
DOM Level 2: The public identifier associated with the entity. |
void | setSystemId(String id)
DOM Level 2: The system identifier associated with the entity. |
void | setXmlEncoding(String value)
NON-DOM
encoding - An attribute specifying, as part of the text declaration,
the encoding of this entity, when it is an external parsed entity.
|
void | setXmlVersion(String value)
NON-DOM
version - An attribute specifying, as part of the text declaration,
the version number of this entity, when it is an external parsed entity.
|
Returns: The absolute base URI of this node or null.
Since: DOM Level 3
null
if it an entity from the internal subset or if it
is not known..Since: DOM Level 3