Class PMRDocumentImpl

java.lang.Object
org.episteme.natural.chemistry.loaders.cml.dom.pmr.PMRNodeImpl
org.episteme.natural.chemistry.loaders.cml.dom.pmr.PMRDocumentImpl
All Implemented Interfaces:
PMRDocument, Document, Node
Direct Known Subclasses:
AbstractCMLDocumentImpl
public class PMRDocumentImpl extends PMRNodeImpl implements PMRDocument
The Document interface represents the entire HTML or XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.

Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a Document, the Document interface also contains the factory methods needed to create these objects. The Node objects created have a ownerDocument attribute which associates them with the Document within whose context they were created.

Since:
1.0
Author:
Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

  • Constructor Details

    • PMRDocumentImpl

      protected PMRDocumentImpl()

    • PMRDocumentImpl

      protected PMRDocumentImpl(PMRDocumentImpl oldPmrDoc)

    • PMRDocumentImpl

      public PMRDocumentImpl(Document document)

  • Method Details

    • getDoctype

      public DocumentType getDoctype()
      The Document Type Declaration (see DocumentType) associated with this document. For HTML documents as well as XML documents without a document type declaration this returns null. The DOM Level 1 does not support editing the Document Type Declaration, therefore docType cannot be altered in any way.
      Specified by:
      getDoctype in interface Document

    • getImplementation

      public DOMImplementation getImplementation()
      The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.
      Specified by:
      getImplementation in interface Document

    • getDocumentElement

      public Element getDocumentElement()
      This is a convenience attribute that allows direct access to the child node that is the root element of the document. For HTML documents, this is the element with the tagName "HTML".
      Specified by:
      getDocumentElement in interface Document

    • createElement

      public Element createElement(String tagName) throws DOMException
      Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.
      Specified by:
      createElement in interface Document
      Parameters:
      tagName - The name of the element type to instantiate. For XML, this is case-sensitive. For HTML, the tagName parameter may be provided in any case, but it must be mapped to the canonical uppercase form by the DOM implementation.
      Returns:
      A new Element object.
      Throws:
      DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.

    • createDocumentFragment

      public DocumentFragment createDocumentFragment()
      Creates an empty DocumentFragment object.
      Specified by:
      createDocumentFragment in interface Document
      Returns:
      A new DocumentFragment.

    • createTextNode

      public Text createTextNode(String data)
      Creates a Text node given the specified string.
      Specified by:
      createTextNode in interface Document
      Parameters:
      data - The data for the node.
      Returns:
      The new Text object.

    • createComment

      public Comment createComment(String data)
      Creates a Comment node given the specified string.
      Specified by:
      createComment in interface Document
      Parameters:
      data - The data for the node.
      Returns:
      The new Comment object.

    • createCDATASection

      public CDATASection createCDATASection(String data) throws DOMException
      Creates a CDATASection node whose value is the specified string.
      Specified by:
      createCDATASection in interface Document
      Parameters:
      data - The data for the CDATASection contents.
      Returns:
      The new CDATASection object.
      Throws:
      DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

    • createProcessingInstruction

      public ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException
      Creates a ProcessingInstruction node given the specified name and data strings.
      Specified by:
      createProcessingInstruction in interface Document
      Parameters:
      target - The target part of the processing instruction.
      data - The data for the node.
      Returns:
      The new ProcessingInstruction object.
      Throws:
      DOMException - INVALID_CHARACTER_ERR: Raised if an invalid character is specified.
      NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

    • createAttribute

      public Attr createAttribute(String name) throws DOMException
      Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttribute method.
      Specified by:
      createAttribute in interface Document
      Parameters:
      name - The name of the attribute.
      Returns:
      A new Attr object.
      Throws:
      DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.

    • createEntityReference

      public EntityReference createEntityReference(String name) throws DOMException
      Creates an EntityReference object.
      Specified by:
      createEntityReference in interface Document
      Parameters:
      name - The name of the entity to reference.
      Returns:
      The new EntityReference object.
      Throws:
      DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.
      NOT_SUPPORTED_ERR: Raised if this document is an HTML document.

    • getElementsByTagName

      public NodeList getElementsByTagName(String name)
      Returns a NodeList of all the Elements with a given tag name in the order in which they would be encountered in a preorder traversal of the Document tree.
      Specified by:
      getElementsByTagName in interface Document
      Parameters:
      name - The name of the tag to match on. The special value "*" matches all tags.
      Returns:
      A new NodeList object containing all the matched Elements.

    • createElementNS

      public Element createElementNS(String s, String t)
      Specified by:
      createElementNS in interface Document

    • getElementsByTagNameNS

      public NodeList getElementsByTagNameNS(String s, String t)
      Specified by:
      getElementsByTagNameNS in interface Document

    • importNode

      public Node importNode(Node node, boolean deepCopy)
      hopefully supported now
      Specified by:
      importNode in interface Document

    • createAttributeNS

      public Attr createAttributeNS(String s, String t)
      Specified by:
      createAttributeNS in interface Document

    • getInputEncoding

      public String getInputEncoding()
      An attribute specifying the encoding used for this document at the time of the parsing. This is null when it is not known, such as when the Document was created in memory.
      Specified by:
      getInputEncoding in interface Document
      Since:
      DOM Level 3

    • getXmlEncoding

      public String getXmlEncoding()
      An attribute specifying, as part of the XML declaration, the encoding of this document. This is null when unspecified or when it is not known, such as when the Document was created in memory.
      Specified by:
      getXmlEncoding in interface Document
      Since:
      DOM Level 3

    • getXmlStandalone

      public boolean getXmlStandalone()
      An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified.

      Note: No verification is done on the value when setting this attribute. Applications should use Document.normalizeDocument() with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].

      Specified by:
      getXmlStandalone in interface Document
      Since:
      DOM Level 3

    • setXmlStandalone

      public void setXmlStandalone(boolean xmlStandalone) throws DOMException
      An attribute specifying, as part of the XML declaration, whether this document is standalone. This is false when unspecified.

      Note: No verification is done on the value when setting this attribute. Applications should use Document.normalizeDocument() with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].

      Specified by:
      setXmlStandalone in interface Document
      Throws:
      DOMException - NOT_SUPPORTED_ERR: Raised if this document does not support the "XML" feature.
      Since:
      DOM Level 3

    • getXmlVersion

      public String getXmlVersion()
      An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "1.0". If this document does not support the "XML" feature, the value is always null. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invoke Document.normalizeDocument() in order to check for invalid characters in the Nodes that are already part of this Document.
      DOM applications may use the DOMImplementation.hasFeature(feature, version) method with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports [XML 1.0]. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports [XML 1.1]. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification. Document objects supporting a version of the "XMLVersion" feature must not raise a NOT_SUPPORTED_ERR exception for the same version number when using Document.xmlVersion.
      Specified by:
      getXmlVersion in interface Document
      Since:
      DOM Level 3

    • setXmlVersion

      public void setXmlVersion(String xmlVersion) throws DOMException
      An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is "1.0". If this document does not support the "XML" feature, the value is always null. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invoke Document.normalizeDocument() in order to check for invalid characters in the Nodes that are already part of this Document.
      DOM applications may use the DOMImplementation.hasFeature(feature, version) method with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports [XML 1.0]. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports [XML 1.1]. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification. Document objects supporting a version of the "XMLVersion" feature must not raise a NOT_SUPPORTED_ERR exception for the same version number when using Document.xmlVersion.
      Specified by:
      setXmlVersion in interface Document
      Throws:
      DOMException - NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not supported by this Document or if this document does not support the "XML" feature.
      Since:
      DOM Level 3

    • getStrictErrorChecking

      public boolean getStrictErrorChecking()
      An attribute specifying whether error checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException on DOM operations or report errors while using Document.normalizeDocument(). In case of error, the behavior is undefined. This attribute is true by default.
      Specified by:
      getStrictErrorChecking in interface Document
      Since:
      DOM Level 3

    • setStrictErrorChecking

      public void setStrictErrorChecking(boolean strictErrorChecking)
      An attribute specifying whether error checking is enforced or not. When set to false, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise any DOMException on DOM operations or report errors while using Document.normalizeDocument(). In case of error, the behavior is undefined. This attribute is true by default.
      Specified by:
      setStrictErrorChecking in interface Document
      Since:
      DOM Level 3

    • getDocumentURI

      public String getDocumentURI()
      The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument. No lexical checking is performed when setting this attribute; this could result in a null value returned when using Node.baseURI .
      Beware that when the Document supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computing Node.baseURI.
      Specified by:
      getDocumentURI in interface Document
      Since:
      DOM Level 3

    • setDocumentURI

      public void setDocumentURI(String documentURI)
      The location of the document or null if undefined or if the Document was created using DOMImplementation.createDocument. No lexical checking is performed when setting this attribute; this could result in a null value returned when using Node.baseURI .
      Beware that when the Document supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computing Node.baseURI.
      Specified by:
      setDocumentURI in interface Document
      Since:
      DOM Level 3

    • adoptNode

      public Node adoptNode(Node source) throws DOMException
      Attempts to adopt a node from another document to this document. If supported, it changes the ownerDocument of the source node, its children, as well as the attached attribute nodes if there are any. If the source node has a parent it is first removed from the child list of its parent. This effectively allows moving a subtree from one document to another (unlike importNode() which create a copy of the source node instead of moving it). When it fails, applications should use Document.importNode() instead. Note that if the adopted node is already part of this document (i.e. the source and target document are the same), this method still has the effect of removing the source node from the child list of its parent, if any. The following list describes the specifics for each type of node.
      ATTRIBUTE_NODE
      The ownerElement attribute is set to null and the specified flag is set to true on the adopted Attr. The descendants of the source Attr are recursively adopted.
      DOCUMENT_FRAGMENT_NODE
      The descendants of the source node are recursively adopted.
      DOCUMENT_NODE
      Document nodes cannot be adopted.
      DOCUMENT_TYPE_NODE
      DocumentType nodes cannot be adopted.
      ELEMENT_NODE
      Specified attribute nodes of the source element are adopted. Default attributes are discarded, though if the document being adopted into defines default attributes for this element name, those are assigned. The descendants of the source element are recursively adopted.
      ENTITY_NODE
      Entity nodes cannot be adopted.
      ENTITY_REFERENCE_NODE
      Only the EntityReference node itself is adopted, the descendants are discarded, since the source and destination documents might have defined the entity differently. If the document being imported into provides a definition for this entity name, its value is assigned.
      NOTATION_NODE
      Notation nodes cannot be adopted.
      PROCESSING_INSTRUCTION_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE
      These nodes can all be adopted. No specifics.

      Note: Since it does not create new nodes unlike the Document.importNode() method, this method does not raise an INVALID_CHARACTER_ERR exception, and applications should use the Document.normalizeDocument() method to check if an imported name is not an XML name according to the XML version in use.

      Specified by:
      adoptNode in interface Document
      Parameters:
      source - The node to move into this document.
      Returns:
      The adopted node, or null if this operation fails, such as when the source node comes from a different implementation.
      Throws:
      DOMException - NOT_SUPPORTED_ERR: Raised if the source node is of type DOCUMENT, DOCUMENT_TYPE.
      NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is readonly.
      Since:
      DOM Level 3

    • getDomConfig

      public DOMConfiguration getDomConfig()
      The configuration used when Document.normalizeDocument() is invoked.
      Specified by:
      getDomConfig in interface Document
      Since:
      DOM Level 3

    • normalizeDocument

      public void normalizeDocument()
      This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. As a consequence, this method updates the replacement tree of EntityReference nodes and normalizes Text nodes, as defined in the method Node.normalize().
      Otherwise, the actual result depends on the features being set on the Document.domConfig object and governing what operations actually take place. Noticeably this method could also make the document namespace well-formed according to the algorithm described in , check the character normalization, remove the CDATASection nodes, etc. See DOMConfiguration for details. 
      // Keep in the document
the information defined // in the XML Information Set (Java example)
DOMConfiguration docConfig = myDocument.getDomConfig();
docConfig.setParameter("infoset", Boolean.TRUE);
myDocument.normalizeDocument();


      Mutation events, when supported, are generated to reflect the changes occurring on the document.
      If errors occur during the invocation of this method, such as an attempt to update a read-only node or a Node.nodeName contains an invalid character according to the XML version in use, errors or warnings (DOMError.SEVERITY_ERROR or DOMError.SEVERITY_WARNING) will be reported using the DOMErrorHandler object associated with the "error-handler " parameter. Note this method might also report fatal errors ( DOMError.SEVERITY_FATAL_ERROR) if an implementation cannot recover from an error.

      Specified by:
      normalizeDocument in interface Document
      Since:
      DOM Level 3

    • renameNode

      public Node renameNode(Node n, String namespaceURI, String qualifiedName) throws DOMException
      Rename an existing node of type ELEMENT_NODE or ATTRIBUTE_NODE.
      When possible this simply changes the name of the given node, otherwise this creates a new node with the specified name and replaces the existing node with the new node as described below.
      If simply changing the name of the given node is not possible, the following operations are performed: a new node is created, any registered event listener is registered on the new node, any user data attached to the old node is removed from that node, the old node is removed from its parent if it has one, the children are moved to the new node, if the renamed node is an Element its attributes are moved to the new node, the new node is inserted at the position the old node used to have in its parent's child nodes list if it has one, the user data that was attached to the old node is attached to the new node.
      When the node being renamed is an Element only the specified attributes are moved, default attributes originated from the DTD are updated according to the new element name. In addition, the implementation may update default attributes from other schemas. Applications should use Document.normalizeDocument() to guarantee these attributes are up-to-date.
      When the node being renamed is an Attr that is attached to an Element, the node is first removed from the Element attributes map. Then, once renamed, either by modifying the existing node or creating a new one as described above, it is put back.
      In addition,
      • a user data event NODE_RENAMED is fired,
      • when the implementation supports the feature "MutationNameEvents", each mutation operation involved in this method fires the appropriate event, and in the end the event { http://www.w3.org/2001/xml-events, DOMElementNameChanged} or { http://www.w3.org/2001/xml-events, DOMAttributeNameChanged} is fired.
      Specified by:
      renameNode in interface Document
      Parameters:
      n - The node to rename.
      namespaceURI - The new namespace URI.
      qualifiedName - The new qualified name.
      Returns:
      The renamed node. This is either the specified node or the new node that was created to replace the specified node.
      Throws:
      DOMException - NOT_SUPPORTED_ERR: Raised when the type of the specified node is neither ELEMENT_NODE nor ATTRIBUTE_NODE, or if the implementation does not support the renaming of the document element.
      INVALID_CHARACTER_ERR: Raised if the new qualified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
      WRONG_DOCUMENT_ERR: Raised when the specified node was created from a different document than this document.
      NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace" [XML Namespaces] . Also raised, when the node being renamed is an attribute, if the qualifiedName, or its prefix, is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/".
      Since:
      DOM Level 3

    • getElementById

      public Element getElementById(String id)
      very crude
      Specified by:
      getElementById in interface Document

    • toString

      public String toString()
      Description copied from class: PMRNodeImpl
      //////////////////////////////////////////////////////////
      Overrides:
      toString in class PMRNodeImpl

    • test

      public static void test(String inFile) throws Exception
      Throws:
      Exception

    • test

      public static void test() throws Exception
      Throws:
      Exception

    • main

      public static void main(String[] args)