FileDocCategorySizeDatePackage
EntityImpl.javaAPI DocJava SE 6 API9811Tue Jun 10 00:22:38 BST 2008com.sun.org.apache.xerces.internal.dom

EntityImpl

public class EntityImpl extends ParentNode implements Entity
Entity nodes hold the reference data for an XML Entity -- either parsed or unparsed. The nodeName (inherited from Node) will contain the name (if any) of the Entity. Its data will be contained in the Entity's children, in exactly the structure which an EntityReference to this name will present within the document's body.

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.
xerces.internal
author
Elena Litani, IBM
version
$Id: EntityImpl.java,v 1.5 2007/05/16 22:45:49 joehw Exp $
since
PR-DOM-Level-1-19980818.

Fields Summary
static final long
serialVersionUID
Serialization version.
protected String
name
Entity name.
protected String
publicId
Public identifier.
protected String
systemId
System identifier.
protected String
encoding
Encoding
protected String
inputEncoding
Input Encoding
protected String
version
Version
protected String
notationName
Notation name.
protected String
baseURI
base uri
Constructors Summary
public EntityImpl(CoreDocumentImpl ownerDoc, String name)
Factory constructor.


    //
    // Constructors
    //

       
         
    	super(ownerDoc);
        this.name = name;
        isReadOnly(true);
Methods Summary
public org.w3c.dom.NodecloneNode(boolean deep)
Clone node.

        EntityImpl newentity = (EntityImpl)super.cloneNode(deep);
        newentity.setReadOnly(true, deep);
        return newentity;
public java.lang.StringgetBaseURI()
Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. Note: If the URI is malformed, a null is returned.

return
The absolute base URI of this node or null.
since
DOM Level 3


        if (needsSyncData()) {
            synchronizeData();
        }
        return (baseURI!=null)?baseURI:((CoreDocumentImpl)getOwnerDocument()).getBaseURI();
public java.lang.StringgetInputEncoding()
An attribute specifying the encoding used for this entity at the tiome of parsing, when it is an external parsed entity. This is null if it an entity from the internal subset or if it is not known..

since
DOM Level 3

        if (needsSyncData()) {
            synchronizeData();
        }
        return inputEncoding;
public java.lang.StringgetNodeName()
Returns the entity name

        if (needsSyncData()) {
            synchronizeData();
        }
        return name;
public shortgetNodeType()
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.

        return Node.ENTITY_NODE;
public java.lang.StringgetNotationName()
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.


        if (needsSyncData()) {
            synchronizeData();
        }
        return notationName;
public java.lang.StringgetPublicId()
The public identifier associated with the entity. If not specified, this will be null.

        
        if (needsSyncData()) {
            synchronizeData();
        }
        return publicId;
public java.lang.StringgetSystemId()
The system identifier associated with the entity. If not specified, this will be null.


        if (needsSyncData()) {
            synchronizeData();
        }
        return systemId;
public java.lang.StringgetXmlEncoding()
DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.


       if (needsSyncData()) {
           synchronizeData();
       }

       return encoding;
public java.lang.StringgetXmlVersion()
DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.


       if (needsSyncData()) {
           synchronizeData();
       }
       return version;
public voidsetBaseURI(java.lang.String uri)
NON-DOM: set base uri

        if (needsSyncData()) {
            synchronizeData();
        }
        baseURI = uri;
public voidsetInputEncoding(java.lang.String inputEncoding)
NON-DOM, used to set the input encoding.

        if (needsSyncData()) {
            synchronizeData();
        }
        this.inputEncoding = inputEncoding;
public voidsetNodeValue(java.lang.String x)
Sets the node value.

throws
DOMException(NO_MODIFICATION_ALLOWED_ERR)

        if (ownerDocument.errorChecking && isReadOnly()) {
            String msg = DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, "NO_MODIFICATION_ALLOWED_ERR", null);
            throw new DOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR, msg);
        }
public voidsetNotationName(java.lang.String name)
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.

        
        if (needsSyncData()) {
            synchronizeData();
        }
    	notationName = name;
public voidsetPrefix(java.lang.String prefix)
The namespace prefix of this node

exception
DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

        if (ownerDocument.errorChecking && isReadOnly()) {
            throw new DOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR, 
                  DOMMessageFormatter.formatMessage(DOMMessageFormatter.DOM_DOMAIN, 
                    "NO_MODIFICATION_ALLOWED_ERR", null));
        }
public voidsetPublicId(java.lang.String id)
DOM Level 2: The public identifier associated with the entity. If not specified, this will be null.

        
        if (needsSyncData()) {
            synchronizeData();
        }
    	publicId = id;
public voidsetSystemId(java.lang.String id)
DOM Level 2: The system identifier associated with the entity. If not specified, this will be null.

        if (needsSyncData()) {
            synchronizeData();
        }
    	systemId = id;
public voidsetXmlEncoding(java.lang.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. This is null otherwise

        if (needsSyncData()) {
            synchronizeData();
        }
        encoding = value;
public voidsetXmlVersion(java.lang.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. This is null otherwise

       
        if (needsSyncData()) {
            synchronizeData();
        }
        version = value;