Package 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:
Serializable, Cloneable, DocumentType, EventTarget, Node, NodeList
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.

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: DocumentTypeImpl.java 699892 2008-09-28 21:08:27Z mrglavas $
Author:
Arnaud Le Hors, IBM, Joe Kesselman, IBM, Andy Clark, IBM
See Also:

  • Field Details

  • 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

    • getPublicId

      public 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 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(String internalSubset)
      NON-DOM.

      Set the internalSubset given as a string.

    • getInternalSubset

      public 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
      Specified by:
      getNodeType in class NodeImpl

    • getNodeName

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

    • cloneNode

      public Node cloneNode(boolean deep)
      Clones the node.
      Specified by:
      cloneNode in interface Node
      Overrides:
      cloneNode in class ParentNode
      See Also:

    • getTextContent

      public String getTextContent() throws DOMException
      Description copied from class: NodeImpl
      This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
      The string returned is made of the text content of this node depending on its type, as defined below: /** This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
      The string returned is made of the text content of this node depending on its type, as defined below:
      Node type Content
      Node type Content
      ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes
      ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
      DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
      Specified by:
      getTextContent in interface Node
      Overrides:
      getTextContent in class ParentNode
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
      DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

    • setTextContent

      public void setTextContent(String textContent) throws DOMException
      Description copied from class: NodeImpl
      This attribute returns the text content of this node and its descendants. When it is defined to be null, setting it has no effect. When set, any possible children this node may have are removed and replaced by a single Text node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed, the returned string does not contain the element content whitespaces . Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
      The string returned is made of the text content of this node depending on its type, as defined below:
      Node type Content
      ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes
      ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE nodeValue
      DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE null
      Specified by:
      setTextContent in interface Node
      Overrides:
      setTextContent in class ParentNode
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
      DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

    • isEqualNode

      public boolean isEqualNode(Node arg)
      DOM Level 3 WD- Experimental. Override inherited behavior from ParentNodeImpl to support deep equal.
      Specified by:
      isEqualNode in interface Node
      Overrides:
      isEqualNode in class ParentNode
      Parameters:
      arg - The node to compare equality with.
      Returns:
      If the nodes, and possibly subtrees are equal, true otherwise false.

    • setOwnerDocument

      protected void setOwnerDocument(CoreDocumentImpl doc)
      NON-DOM set the ownerDocument of this node and its children
      Overrides:
      setOwnerDocument in class ParentNode

    • getNodeNumber

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

    • 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.
      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
      Parameters:
      readOnly - True or false as desired.
      deep - If true, children are also toggled. Note that this will not change the state of an EntityReference or its children, which are always read-only.
      See Also:

    • getElements

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

    • setUserData

      public Object setUserData(String key, Object data, UserDataHandler handler)
      Description copied from class: NodeImpl
      Associate an object to a key on this node. The object can later be retrieved from this node by calling getUserData with the same key.
      Specified by:
      setUserData in interface Node
      Overrides:
      setUserData in class NodeImpl
      Parameters:
      key - The key to associate the object to.
      data - The object to associate to the given key, or null to remove any existing association to that key.
      handler - The handler to associate to that key, or null.
      Returns:
      Returns the DOMObject previously associated to the given key on this node, or null if there was none.

    • getUserData

      public Object getUserData(String key)
      Description copied from class: NodeImpl
      Retrieves the object associated to a key on a this node. The object must first have been set to this node by calling setUserData with the same key.
      Specified by:
      getUserData in interface Node
      Overrides:
      getUserData in class NodeImpl
      Parameters:
      key - The key the object is associated to.
      Returns:
      Returns the DOMObject associated to the given key on this node, or null if there was none.

    • getUserDataRecord

      protected Hashtable getUserDataRecord()
      Overrides:
      getUserDataRecord in class NodeImpl