Package org.apache.xerces.dom

Class DocumentTypeImpl

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.w3c.dom.DocumentType, org.w3c.dom.events.EventTarget, org.w3c.dom.Node, org.w3c.dom.NodeList
    Direct Known Subclasses:
    DeferredDocumentTypeImpl
    public class DocumentTypeImpl
extends ParentNode
implements org.w3c.dom.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:
    Serialized Form

    • Field Detail

      • name

        protected java.lang.String name
        Document type name.

      • 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 org.w3c.dom.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 org.w3c.dom.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 org.w3c.dom.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 org.w3c.dom.Node
        Specified by:
        getNodeType in class NodeImpl

      • getNodeName

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

      • getTextContent

        public java.lang.String getTextContent()
                                throws org.w3c.dom.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 org.w3c.dom.Node
        Overrides:
        getTextContent in class ParentNode
        Throws:
        org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

      • setTextContent

        public void setTextContent​(java.lang.String textContent)
                    throws org.w3c.dom.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 org.w3c.dom.Node
        Overrides:
        setTextContent in class ParentNode
        Throws:
        org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

      • isEqualNode

        public boolean isEqualNode​(org.w3c.dom.Node arg)
        DOM Level 3 WD- Experimental. Override inherited behavior from ParentNodeImpl to support deep equal.
        Specified by:
        isEqualNode in interface org.w3c.dom.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.

      • getNodeNumber

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

      • 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 org.w3c.dom.DocumentType

      • getEntities

        public org.w3c.dom.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 org.w3c.dom.DocumentType

      • getNotations

        public org.w3c.dom.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 org.w3c.dom.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:
        NodeImpl.setReadOnly(boolean, boolean)

      • getElements

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

      • setUserData

        public java.lang.Object setUserData​(java.lang.String key,
                                    java.lang.Object data,
                                    org.w3c.dom.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 org.w3c.dom.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 java.lang.Object getUserData​(java.lang.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 org.w3c.dom.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.