org.apache.xerces.dom

Class DocumentTypeImpl

Implemented Interfaces:
Cloneable, DocumentType, EventTarget, Node, NodeList, Serializable
Known Direct Subclasses:
DeferredDocumentTypeImpl

public class DocumentTypeImpl
extends ParentNode
implements DocumentType

This class represents a Document Type declaraction in the document itself, not a Document Type Definition (DTD). An XML document may (or may not) have such a reference.

DocumentType is an Extended DOM feature, used in XML documents but not in HTML.

Note that Entities and Notations are no longer children of the DocumentType, but are parentless nodes hung only in their appropriate NamedNodeMaps.

This area is UNDERSPECIFIED IN REC-DOM-Level-1-19981001 Most notably, absolutely no provision was made for storing and using Element and Attribute information. Nor was the linkage between Entities and Entity References nailed down solidly.

Version:
$Id: DocumentTypeImpl.java,v 1.29 2005/05/02 22:02:22 mrglavas Exp $
Authors:
Arnaud Le Hors, IBM
Joe Kesselman, IBM
Andy Clark, IBM
Since:
PR-DOM-Level-1-19980818.

Field Summary

protected NamedNodeMapImpl
elements
Elements.
protected NamedNodeMapImpl
entities
Entities.
protected String
internalSubset
protected String
name
Document type name.
protected NamedNodeMapImpl
notations
Notations.
protected String
publicID
protected String
systemID

Fields inherited from class org.apache.xerces.dom.ParentNode

fNodeListCache, firstChild, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE, flags, ownerNode

Constructor Summary

DocumentTypeImpl(CoreDocumentImpl ownerDocument, String name)
Factory method for creating a document type node.
DocumentTypeImpl(CoreDocumentImpl ownerDocument, String qualifiedName, String publicID, String systemID)
Factory method for creating a document type node.

Method Summary

Node
cloneNode(boolean deep)
Clones the node.
NamedNodeMap
getElements()
NON-DOM: Access the collection of ElementDefinitions.
NamedNodeMap
getEntities()
Access the collection of general Entities, both external and internal, defined in the DTD.
String
getInternalSubset()
Introduced in DOM Level 2.
String
getName()
Name of this document type.
String
getNodeName()
Returns the document type name
protected int
getNodeNumber()
NON-DOM Get the number associated with this doctype.
short
getNodeType()
A short integer indicating what type of node this is.
NamedNodeMap
getNotations()
Access the collection of Notations defined in the DTD.
String
getPublicId()
Introduced in DOM Level 2.
String
getSystemId()
Introduced in DOM Level 2.
String
getTextContent()
Object
getUserData(String key)
protected Hashtable
getUserDataRecord()
boolean
isEqualNode(Node arg)
DOM Level 3 WD- Experimental.
void
setInternalSubset(String internalSubset)
NON-DOM.
void
setReadOnly(boolean readOnly, boolean deep)
NON-DOM: Subclassed to flip the entities' and notations' readonly switch as well.
void
setTextContent(String textContent)
Object
setUserData(String key, Object data, UserDataHandler handler)

Methods inherited from class org.apache.xerces.dom.ParentNode

cloneNode, getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, hasChildNodes, insertBefore, isEqualNode, item, normalize, removeChild, replaceChild, setReadOnly, setTextContent, synchronizeChildren

Methods inherited from class org.apache.xerces.dom.ChildNode

cloneNode, getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, appendChild, changed, changes, cloneNode, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getBaseURI, getChildNodes, getContainer, getFeature, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeNumber, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getReadOnly, getTextContent, getUserData, getUserData, getUserDataRecord, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, needsSyncChildren, normalize, removeChild, removeEventListener, replaceChild, setNodeValue, setPrefix, setReadOnly, setTextContent, setUserData, setUserData, synchronizeData, toString

Field Details

elements

protected NamedNodeMapImpl elements
Elements.

entities

protected NamedNodeMapImpl entities
Entities.

internalSubset

protected String internalSubset

name

protected String name
Document type name.

notations

protected NamedNodeMapImpl notations
Notations.

publicID

protected String publicID

systemID

protected String systemID

Constructor Details

DocumentTypeImpl

public DocumentTypeImpl(CoreDocumentImpl ownerDocument,
                        String name)
Factory method for creating a document type node.

DocumentTypeImpl

public DocumentTypeImpl(CoreDocumentImpl ownerDocument,
                        String qualifiedName,
                        String publicID,
                        String systemID)
Factory method for creating a document type node.

Method Details

cloneNode

public Node cloneNode(boolean deep)
Clones the node.
Overrides:
cloneNode in interface ParentNode

getElements

public NamedNodeMap getElements()
NON-DOM: Access the collection of ElementDefinitions.

getEntities

public NamedNodeMap getEntities()
Access the collection of general Entities, both external and internal, defined in the DTD. For example, in:

   <!doctype example SYSTEM "ex.dtd" [
     <!ENTITY foo "foo">
     <!ENTITY bar "bar">
     <!ENTITY % baz "baz">
     ]>
 

The Entities map includes foo and bar, but not baz. It is promised that only Nodes which are Entities will exist in this NamedNodeMap.

For HTML, this will always be null.

Note that "built in" entities such as & and < should be converted to their actual characters before being placed in the DOM's contained text, and should be converted back when the DOM is rendered as XML or HTML, and hence DO NOT appear here.


getInternalSubset

public String getInternalSubset()
Introduced in DOM Level 2.

Return the internalSubset given as a string.

Since:
WD-DOM-Level-2-19990923

getName

public String getName()
Name of this document type. If we loaded from a DTD, this should be the name immediately following the DOCTYPE keyword.

getNodeName

public String getNodeName()
Returns the document type name
Overrides:
getNodeName in interface NodeImpl

getNodeNumber

protected int getNodeNumber()
NON-DOM Get the number associated with this doctype.
Overrides:
getNodeNumber in interface NodeImpl

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.
Overrides:
getNodeType in interface NodeImpl

getNotations

public NamedNodeMap getNotations()
Access the collection of Notations defined in the DTD. A notation declares, by name, the format of an XML unparsed entity or is used to formally declare a Processing Instruction target.

getPublicId

public String getPublicId()
Introduced in DOM Level 2.

Return the public identifier of this Document type.

Since:
WD-DOM-Level-2-19990923

getSystemId

public String getSystemId()
Introduced in DOM Level 2.

Return the system identifier of this Document type.

Since:
WD-DOM-Level-2-19990923

getTextContent

public String getTextContent()
            throws DOMException
Overrides:
getTextContent in interface ParentNode

getUserData

public Object getUserData(String key)
Overrides:
getUserData in interface NodeImpl

getUserDataRecord

protected Hashtable getUserDataRecord()
Overrides:
getUserDataRecord in interface NodeImpl

isEqualNode

public boolean isEqualNode(Node arg)
DOM Level 3 WD- Experimental. Override inherited behavior from ParentNodeImpl to support deep equal.
Overrides:
isEqualNode in interface ParentNode

setInternalSubset

public void setInternalSubset(String internalSubset)
NON-DOM.

Set the internalSubset given as a string.


setReadOnly

public void setReadOnly(boolean readOnly,
                        boolean deep)
NON-DOM: Subclassed to flip the entities' and notations' readonly switch as well.
Overrides:
setReadOnly in interface ParentNode

setTextContent

public void setTextContent(String textContent)
            throws DOMException
Overrides:
setTextContent in interface ParentNode

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)
Overrides:
setUserData in interface NodeImpl

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.