Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.xml.dom

Class DomEntity

Implemented Interfaces:
Cloneable, Comparable, DocumentEvent, Entity, EventTarget, Node, NodeList
public class DomEntity
extends DomExtern
implements Entity
"Entity" implementation. This is a non-core DOM class, supporting the "XML" feature. There are two types of entities, neither of which works particularly well in this API:
Unparsed Entities
Since ENTITY/ENTITIES attributes, the only legal use of unparsed entities in XML, can't be detected with DOM, there isn't much point in trying to use unparsed entities in DOM applications. (XML Linking is working to provide a better version of this functionality.)
Parsed Entities
While the DOM specification permits nodes for parsed entities to have a readonly set of children, this is not required and there is no portable way to provide such children. This implementation currently does not permit children to be added to Entities. There are related issues with the use of EntityReference nodes.

In short, avoid using this DOM functionality.

See Also:
DomDoctype, DomEntityReference, DomNotation

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

DomEntity(DomDocument owner, String name, String publicId, String systemId, String notation)
Constructs an Entity node associated with the specified document, with the specified descriptive data.

Method Summary

String
getBaseURI()
The base URI of an external entity is its system ID.
String
getInputEncoding()
String
getNotationName()
DOM L1 Returns the NOTATION identifier associated with this entity, if any.
String
getXmlEncoding()
String
getXmlVersion()

Methods inherited from class gnu.xml.dom.DomExtern

getLocalName, getNodeName, getPublicId, getSystemId

Methods inherited from class gnu.xml.dom.DomNode

addEventListener, appendChild, clone, cloneNode, compact, compareDocumentPosition, compareTo, createEvent, dispatchEvent, getAttributes, getBaseURI, getChildNodes, getElementsByTagName, getElementsByTagNameNS, getFeature, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isReadonly, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, makeReadonly, nameAndTypeEquals, normalize, removeChild, removeEventListener, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData, toString, trimToSize

Constructor Details

DomEntity

protected DomEntity(DomDocument owner,
                    String name,
                    String publicId,
                    String systemId,
                    String notation)
Constructs an Entity node associated with the specified document, with the specified descriptive data.

This constructor should only be invoked by a DomDoctype as part of its declareEntity functionality, or through a subclass which is similarly used in a "Sub-DOM" style layer.

Parameters:
owner - The document with which this entity is associated
name - Name of this entity
publicId - If non-null, provides the entity's PUBLIC identifier
systemId - Provides the entity's SYSTEM identifier (URI)
notation - If non-null, provides the unparsed entity's notation.

Method Details

getBaseURI

public String getBaseURI()
The base URI of an external entity is its system ID. The base URI of an internal entity is the parent document's base URI.
Specified by:
getBaseURI in interface Node
Overrides:
getBaseURI in interface DomNode

Since:
DOM Level 3 Core

getInputEncoding

public String getInputEncoding()
Specified by:
getInputEncoding in interface Entity

getNotationName

public final String getNotationName()
DOM L1 Returns the NOTATION identifier associated with this entity, if any.
Specified by:
getNotationName in interface Entity

getXmlEncoding

public String getXmlEncoding()
Specified by:
getXmlEncoding in interface Entity

getXmlVersion

public String getXmlVersion()
Specified by:
getXmlVersion in interface Entity

Overview Package Tree Index Deprecated About