org.apache.xerces.dom
Class DocumentTypeImpl

java.lang.Object
  |
  +--org.apache.xerces.dom.NodeImpl
        |
        +--org.apache.xerces.dom.ChildNode
              |
              +--org.apache.xerces.dom.ParentNode
                    |
                    +--org.apache.xerces.dom.DocumentTypeImpl
All Implemented Interfaces:
java.lang.Cloneable, DocumentType, EventTarget, Node, NodeList, java.io.Serializable
Direct Known 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.

Since:
PR-DOM-Level-1-19980818.
Version:
 
Author:
Arnaud Le Hors, IBM, Joe Kesselman, IBM, Andy Clark, IBM
See Also:
Serialized Form

Field Summary
protected  NamedNodeMapImpl elements
          Elements.
protected  NamedNodeMapImpl entities
          Entities.
protected  java.lang.String internalSubset
           
protected  java.lang.String name
          Document type name.
protected  NamedNodeMapImpl notations
          Notations.
protected  java.lang.String publicID
           
protected  java.lang.String systemID
           
 
Fields inherited from class org.apache.xerces.dom.ParentNode
fCachedChild, fCachedChildIndex, fCachedLength, firstChild, ownerDocument
 
Fields inherited from class org.apache.xerces.dom.ChildNode
nextSibling, previousSibling
 
Fields inherited from class org.apache.xerces.dom.NodeImpl
ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, IGNORABLEWS, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, UNNORMALIZED
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
DocumentTypeImpl(CoreDocumentImpl ownerDocument, java.lang.String name)
          Factory method for creating a document type node.
DocumentTypeImpl(CoreDocumentImpl ownerDocument, java.lang.String qualifiedName, java.lang.String publicID, java.lang.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.
 java.lang.String getInternalSubset()
          Introduced in DOM Level 2.
 java.lang.String getName()
          Name of this document type.
 java.lang.String getNodeName()
          Returns the document type name
 short getNodeType()
          A short integer indicating what type of node this is.
 NamedNodeMap getNotations()
          Access the collection of Notations defined in the DTD.
 java.lang.String getPublicId()
          Introduced in DOM Level 2.
 java.lang.String getSystemId()
          Introduced in DOM Level 2.
 void setInternalSubset(java.lang.String internalSubset)
          NON-DOM.
 void setReadOnly(boolean readOnly, boolean deep)
          NON-DOM: Subclassed to flip the entities' and notations' readonly switch as well.
 
Methods inherited from class org.apache.xerces.dom.ParentNode
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, hasChildNodes, insertBefore, item, normalize, removeChild, replaceChild, synchronizeChildren
 
Methods inherited from class org.apache.xerces.dom.ChildNode
getNextSibling, getParentNode, getPreviousSibling
 
Methods inherited from class org.apache.xerces.dom.NodeImpl
addEventListener, appendChild, changed, changes, dispatchEvent, getAttributes, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, hasAttributes, isSupported, removeEventListener, setNodeValue, setPrefix, setUserData, synchronizeData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Node
appendChild, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 

Field Detail

name

protected java.lang.String name
Document type name.

entities

protected NamedNodeMapImpl entities
Entities.

notations

protected NamedNodeMapImpl notations
Notations.

elements

protected NamedNodeMapImpl elements
Elements.

publicID

protected java.lang.String publicID

systemID

protected java.lang.String systemID

internalSubset

protected java.lang.String internalSubset
Constructor Detail

DocumentTypeImpl

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

DocumentTypeImpl

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

getPublicId

public java.lang.String getPublicId()
Introduced in DOM Level 2.

Return the public identifier of this Document type.

Specified by:
getPublicId in interface DocumentType
Since:
WD-DOM-Level-2-19990923

getSystemId

public java.lang.String getSystemId()
Introduced in DOM Level 2.

Return the system identifier of this Document type.

Specified by:
getSystemId in interface DocumentType
Since:
WD-DOM-Level-2-19990923

setInternalSubset

public void setInternalSubset(java.lang.String internalSubset)
NON-DOM.

Set the internalSubset given as a string.


getInternalSubset

public java.lang.String getInternalSubset()
Introduced in DOM Level 2.

Return the internalSubset given as a string.

Specified by:
getInternalSubset in interface DocumentType
Since:
WD-DOM-Level-2-19990923

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.
Specified by:
getNodeType in interface Node
Overrides:
getNodeType in class NodeImpl

getNodeName

public java.lang.String getNodeName()
Returns the document type name
Specified by:
getNodeName in interface Node
Overrides:
getNodeName in class NodeImpl

cloneNode

public Node cloneNode(boolean deep)
Clones the node.
Specified by:
cloneNode in interface Node
Overrides:
cloneNode in class ParentNode
Following copied from interface: org.w3c.dom.Node
Parameters:
deepIf - true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
Returns:
The duplicate node.

getName

public java.lang.String getName()
Name of this document type. If we loaded from a DTD, this should be the name immediately following the DOCTYPE keyword.
Specified by:
getName in interface DocumentType

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.

Specified by:
getEntities in interface DocumentType

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.
Specified by:
getNotations in interface DocumentType

setReadOnly

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

getElements

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


Copyright 1999-2001 Apache XML Project. All Rights Reserved.