org.apache.xerces.dom

Class 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.

INTERNAL:

Usage of this class is not supported. It may be altered or removed at any time.

Since: PR-DOM-Level-1-19980818.

Version: $Id: EntityImpl.java,v 1.26 2004/10/05 17:12:51 mrglavas Exp $

Author: Elena Litani, IBM

Field Summary
protected StringbaseURI
base uri
protected Stringencoding
Encoding
protected StringinputEncoding
Input Encoding
protected Stringname
Entity name.
protected StringnotationName
Notation name.
protected StringpublicId
Public identifier.
protected StringsystemId
System identifier.
protected Stringversion
Version
Constructor Summary
EntityImpl(CoreDocumentImpl ownerDoc, String name)
Factory constructor.
Method Summary
NodecloneNode(boolean deep)
Clone node.
StringgetBaseURI()
Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
StringgetInputEncoding()
An attribute specifying the encoding used for this entity at the tiome of parsing, when it is an external parsed entity.
StringgetNodeName()
Returns the entity name
shortgetNodeType()
A short integer indicating what type of node this is.
StringgetNotationName()
Unparsed entities -- which contain non-XML data -- have a "notation name" which tells applications how to deal with them.
StringgetPublicId()
The public identifier associated with the entity.
StringgetSystemId()
The system identifier associated with the entity.
StringgetXmlEncoding()
DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.
StringgetXmlVersion()
DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.
voidsetBaseURI(String uri)
NON-DOM: set base uri
voidsetInputEncoding(String inputEncoding)
NON-DOM, used to set the input encoding.
voidsetNotationName(String name)
DOM Level 2: Unparsed entities -- which contain non-XML data -- have a "notation name" which tells applications how to deal with them.
voidsetPublicId(String id)
DOM Level 2: The public identifier associated with the entity.
voidsetSystemId(String id)
DOM Level 2: The system identifier associated with the entity.
voidsetXmlEncoding(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.
voidsetXmlVersion(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.

Field Detail

baseURI

protected String baseURI
base uri

encoding

protected String encoding
Encoding

inputEncoding

protected String inputEncoding
Input Encoding

name

protected String name
Entity name.

notationName

protected String notationName
Notation name.

publicId

protected String publicId
Public identifier.

systemId

protected String systemId
System identifier.

version

protected String version
Version

Constructor Detail

EntityImpl

public EntityImpl(CoreDocumentImpl ownerDoc, String name)
Factory constructor.

Method Detail

cloneNode

public Node cloneNode(boolean deep)
Clone node.

getBaseURI

public String getBaseURI()
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.

Returns: The absolute base URI of this node or null.

Since: DOM Level 3

getInputEncoding

public String getInputEncoding()
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

getNodeName

public String getNodeName()
Returns the entity name

getNodeType

public short getNodeType()
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.

getNotationName

public String getNotationName()
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.

getPublicId

public String getPublicId()
The public identifier associated with the entity. If not specified, this will be null.

getSystemId

public String getSystemId()
The system identifier associated with the entity. If not specified, this will be null.

getXmlEncoding

public String getXmlEncoding()
DOM Level 3 WD - experimental the encoding of this entity, when it is an external parsed entity.

getXmlVersion

public String getXmlVersion()
DOM Level 3 WD - experimental the version number of this entity, when it is an external parsed entity.

setBaseURI

public void setBaseURI(String uri)
NON-DOM: set base uri

setInputEncoding

public void setInputEncoding(String inputEncoding)
NON-DOM, used to set the input encoding.

setNotationName

public 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. Parsed entities, which are in XML format, don't need this and set it to null.

setPublicId

public void setPublicId(String id)
DOM Level 2: The public identifier associated with the entity. If not specified, this will be null.

setSystemId

public void setSystemId(String id)
DOM Level 2: The system identifier associated with the entity. If not specified, this will be null.

setXmlEncoding

public 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. This is null otherwise

setXmlVersion

public 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. This is null otherwise
Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.