* 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. * * * @version * @since PR-DOM-Level-1-19980818. */ public class EntityImpl extends ParentNode implements Entity { // // Constants // /** Serialization version. */ static final long serialVersionUID = -3575760943444303423L; // // Data // /** Entity name. */ protected String name; /** Public identifier. */ protected String publicId; /** System identifier. */ protected String systemId; /** Encoding */ protected String encoding; /** Version */ protected String version; /** Notation name. */ protected String notationName; // // Constructors // /** Factory constructor. */ public EntityImpl(CoreDocumentImpl ownerDoc, String name) { super(ownerDoc); this.name = name; isReadOnly(true); } // // Node methods // /** * A short integer indicating what type of node this is. The named * constants for this value are defined in the org.w3c.dom.Node interface. */ public short getNodeType() { return Node.ENTITY_NODE; } /** * Returns the entity name */ public String getNodeName() { if (needsSyncData()) { synchronizeData(); } return name; } /** Clone node. */ public Node cloneNode(boolean deep) { EntityImpl newentity = (EntityImpl)super.cloneNode(deep); return newentity; } // // Entity methods // /** * The public identifier associated with the entity. If not specified, * this will be null. */ public String getPublicId() { if (needsSyncData()) { synchronizeData(); } return publicId; } // getPublicId():String /** * The system identifier associated with the entity. If not specified, * this will be null. */ public String getSystemId() { if (needsSyncData()) { synchronizeData(); } return systemId; } // getSystemId():String /** * DOM Level 3 WD - experimental * the version number of this entity, when it is an external parsed entity. */ public String getVersion() { if (needsSyncData()) { synchronizeData(); } return version; } // getVersion():String /** * DOM Level 3 WD - experimental * the encoding of this entity, when it is an external parsed entity. */ public String getEncoding() { if (needsSyncData()) { synchronizeData(); } return encoding; } // getVersion():String /** * Unparsed entities -- which contain non-XML data -- have a * "notation name" which tells applications how to deal with them. * Parsed entities, which are in XML format, don't need this and * set it to null. */ public String getNotationName() { if (needsSyncData()) { synchronizeData(); } return notationName; } // getNotationName():String // // Public methods // /** * DOM Level 2: The public identifier associated with the entity. If not specified, * this will be null. */ public void setPublicId(String id) { if (needsSyncData()) { synchronizeData(); } publicId = id; } // setPublicId(String) /** * DOM Level 3 WD - experimental * encoding - 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 */ public void setEncoding(String value) { if (needsSyncData()) { synchronizeData(); } encoding = value; } // setEncoding (String) /** * DOM Level 3 WD - experimental * version - 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 */ public void setVersion(String value) { if (needsSyncData()) { synchronizeData(); } version = value; } // setVersion (String) /** * DOM Level 2: The system identifier associated with the entity. If not * specified, this will be null. */ public void setSystemId(String id) { if (needsSyncData()) { synchronizeData(); } systemId = id; } // setSystemId(String) /** * DOM Level 2: Unparsed entities -- which contain non-XML data -- have a * "notation name" which tells applications how to deal with them. * Parsed entities, which are in XML format, don't need this and * set it to null. */ public void setNotationName(String name) { if (needsSyncData()) { synchronizeData(); } notationName = name; } // setNotationName(String) } // class EntityImpl