Project dom4j 1.5.2 [5/2/05 10:13 PM]
 
Coverage - org/dom4j/dom/DOMDocument.java
  /*
   * Copyright 2001-2004 (C) MetaStuff, Ltd. All Rights Reserved.
   *
   * This software is open source.
   * See the bottom of this file for the licence.
   *
   * $Id: DOMDocument.java,v 1.15 2004/06/25 08:03:35 maartenc Exp $
   */
 
  package org.dom4j.dom;
 
  import java.util.ArrayList;
 
  import org.dom4j.DocumentFactory;
  import org.dom4j.QName;
  import org.dom4j.tree.DefaultDocument;
  import org.w3c.dom.DOMException;
  import org.w3c.dom.NamedNodeMap;
  import org.w3c.dom.NodeList;
 
  /** <p><code>DOMDocument</code> implements an XML document which
    * supports the W3C DOM API.</p>
    *
    * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
    * @version $Revision: 1.15 $
    */
  public class DOMDocument extends DefaultDocument implements org.w3c.dom.Document {
 
      /** The <code>DocumentFactory</code> instance used by default */
      private static final DOMDocumentFactory DOCUMENT_FACTORY = (DOMDocumentFactory) DOMDocumentFactory.getInstance();
 
 
10x       public DOMDocument() {
10x           init();
10x       }
 
      public DOMDocument(String name) {
4x           super(name);
4x           init();
4x       }
 
      public DOMDocument(DOMElement rootElement) {
0x           super(rootElement);
0x           init();
0x       }
 
      public DOMDocument(DOMDocumentType docType) {
0x           super(docType);
0x           init();
0x       }
 
      public DOMDocument(DOMElement rootElement, DOMDocumentType docType) {
0x           super(rootElement, docType);
0x           init();
0x       }
 
      public DOMDocument(String name, DOMElement rootElement, DOMDocumentType docType) {
0x           super(name, rootElement, docType);
0x           init();
0x       }
 
      private void init() {
14x           setDocumentFactory(DOCUMENT_FACTORY);
14x       }
 
      // org.w3c.dom.Node interface
      //-------------------------------------------------------------------------
      public boolean supports(String feature, String version) {
0x           return DOMNodeHelper.supports(this, feature, version);
      }
 
      public String getNamespaceURI() {
0x           return DOMNodeHelper.getNamespaceURI(this);
      }
 
      public String getPrefix() {
0x           return DOMNodeHelper.getPrefix(this);
      }
 
      public void setPrefix(String prefix) throws DOMException {
0x           DOMNodeHelper.setPrefix(this, prefix);
0x       }
 
      public String getLocalName() {
0x           return DOMNodeHelper.getLocalName(this);
      }
 
      public String getNodeName() {
0x           return "#document";
      }
 
      //already part of API
      //
      //public short getNodeType();
 
 
 
      public String getNodeValue() throws DOMException {
0x           return null;
      }
 
      public void setNodeValue(String nodeValue) throws DOMException {
0x       }
 
 
      public org.w3c.dom.Node getParentNode() {
0x           return DOMNodeHelper.getParentNode(this);
      }
 
      public NodeList getChildNodes() {
0x           return DOMNodeHelper.createNodeList( content() );
      }
 
      public org.w3c.dom.Node getFirstChild() {
0x           return DOMNodeHelper.asDOMNode( node(0) );
      }
 
      public org.w3c.dom.Node getLastChild() {
0x           return DOMNodeHelper.asDOMNode( node( nodeCount() - 1 ) );
      }
 
      public org.w3c.dom.Node getPreviousSibling() {
0x           return DOMNodeHelper.getPreviousSibling(this);
      }
 
      public org.w3c.dom.Node getNextSibling() {
0x           return DOMNodeHelper.getNextSibling(this);
      }
 
      public NamedNodeMap getAttributes() {
0x           return null;
      }
 
      public org.w3c.dom.Document getOwnerDocument() {
0x           return null;
      }
 
      public org.w3c.dom.Node insertBefore(
          org.w3c.dom.Node newChild,
          org.w3c.dom.Node refChild
      ) throws DOMException {
0x           checkNewChildNode(newChild);
0x           return DOMNodeHelper.insertBefore(this, newChild, refChild);
      }
 
      public org.w3c.dom.Node replaceChild(
          org.w3c.dom.Node newChild,
          org.w3c.dom.Node oldChild
      ) throws DOMException {
0x           checkNewChildNode(newChild);
0x           return DOMNodeHelper.replaceChild(this, newChild, oldChild);
      }
 
      public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild) throws DOMException {
0x           return DOMNodeHelper.removeChild(this, oldChild);
      }
 
      public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild) throws DOMException {
4x           checkNewChildNode(newChild);
4x           return DOMNodeHelper.appendChild(this, newChild);
      }
 
      private void checkNewChildNode(org.w3c.dom.Node newChild) throws DOMException {
4x           final int nodeType = newChild.getNodeType();
1/8 4x           if (!(nodeType == org.w3c.dom.Node.ELEMENT_NODE ||
                nodeType == org.w3c.dom.Node.COMMENT_NODE ||
                nodeType == org.w3c.dom.Node.PROCESSING_INSTRUCTION_NODE ||
                nodeType == org.w3c.dom.Node.DOCUMENT_TYPE_NODE)) {
0x               throw new DOMException(DOMException.HIERARCHY_REQUEST_ERR,
                 "Specified node cannot be a child of document");
          }
4x       }
      
 
      public boolean hasChildNodes() {
0/2 0x           return nodeCount() > 0;
      }
 
      public org.w3c.dom.Node cloneNode(boolean deep) {
0x           return DOMNodeHelper.cloneNode(this, deep);
      }
 
      public boolean isSupported(String feature, String version) {
0x           return DOMNodeHelper.isSupported(this, feature, version);
      }
 
      public boolean hasAttributes() {
0x           return DOMNodeHelper.hasAttributes(this);
      }
 
 
      // org.w3c.dom.Document interface
      //-------------------------------------------------------------------------
      public NodeList getElementsByTagName(String name) {
0x           ArrayList list = new ArrayList();
0x           DOMNodeHelper.appendElementsByTagName( list, this, name );
0x           return DOMNodeHelper.createNodeList( list );
      }
 
      public NodeList getElementsByTagNameNS(
          String namespaceURI, String localName
      ) {
0x           ArrayList list = new ArrayList();
0x           DOMNodeHelper.appendElementsByTagNameNS(list, this, namespaceURI, localName );
0x           return DOMNodeHelper.createNodeList( list );
      }
 
 
      public org.w3c.dom.DocumentType getDoctype() {
0x           return DOMNodeHelper.asDOMDocumentType( getDocType() );
      }
 
      public org.w3c.dom.DOMImplementation getImplementation() {
0/2 0x           if (getDocumentFactory() instanceof org.w3c.dom.DOMImplementation) {
0x               return (org.w3c.dom.DOMImplementation) getDocumentFactory();
          }
          else {
0x               return DOCUMENT_FACTORY;
          }
 
      }
 
      public org.w3c.dom.Element getDocumentElement() {
2x           return DOMNodeHelper.asDOMElement( getRootElement() );
      }
 
      public org.w3c.dom.Element createElement(String tagName) throws DOMException {
14x           return (org.w3c.dom.Element) getDocumentFactory().createElement(tagName);
      }
 
      public org.w3c.dom.DocumentFragment createDocumentFragment() {
0x           DOMNodeHelper.notSupported();
0x           return null;
      }
 
      public org.w3c.dom.Text createTextNode(String data) {
0x           return (org.w3c.dom.Text) getDocumentFactory().createText(data);
      }
 
      public org.w3c.dom.Comment createComment(String data) {
0x           return (org.w3c.dom.Comment) getDocumentFactory().createComment(data);
      }
 
      public org.w3c.dom.CDATASection createCDATASection(String data) throws DOMException {
0x           return (org.w3c.dom.CDATASection) getDocumentFactory().createCDATA(data);
      }
 
      public org.w3c.dom.ProcessingInstruction createProcessingInstruction(
          String target, String data
      ) throws DOMException {
0x           return (org.w3c.dom.ProcessingInstruction) getDocumentFactory().createProcessingInstruction(target, data);
      }
 
      public org.w3c.dom.Attr createAttribute(String name) throws DOMException {
0x           QName qname = getDocumentFactory().createQName(name);
0x           return (org.w3c.dom.Attr) getDocumentFactory().createAttribute(null, qname, "");
      }
 
      public org.w3c.dom.EntityReference createEntityReference(String name) throws DOMException {
0x           return (org.w3c.dom.EntityReference) ((DOMDocumentFactory) getDocumentFactory()).createEntity(name);
      }
 
      public org.w3c.dom.Node importNode(
          org.w3c.dom.Node importedNode, boolean deep
      ) throws DOMException {
0x           DOMNodeHelper.notSupported();
0x           return null;
      }
 
      public org.w3c.dom.Element createElementNS(
          String namespaceURI, String qualifiedName
      ) throws DOMException {
0x           QName qname = getDocumentFactory().createQName( qualifiedName, namespaceURI );
0x           return (org.w3c.dom.Element) getDocumentFactory().createElement(qname);
      }
 
      public org.w3c.dom.Attr createAttributeNS(
          String namespaceURI, String qualifiedName
      ) throws DOMException {
0x           QName qname = getDocumentFactory().createQName( qualifiedName, namespaceURI );
0x           return (org.w3c.dom.Attr) getDocumentFactory().createAttribute(null, qname, null);
      }
 
 
      public org.w3c.dom.Element getElementById(String elementId) {
0x           return DOMNodeHelper.asDOMElement( elementByID( elementId ) );
      }
 
 
 
      // Implementation methods
      //-------------------------------------------------------------------------
      protected DocumentFactory getDocumentFactory() {
1/2 56x           if (super.getDocumentFactory() == null) {
0x               return DOCUMENT_FACTORY;
          }
          else {
56x               return super.getDocumentFactory();
          }
      }
  }
 
 
 
 
  /*
   * Redistribution and use of this software and associated documentation
   * ("Software"), with or without modification, are permitted provided
   * that the following conditions are met:
   *
   * 1. Redistributions of source code must retain copyright
   *    statements and notices.  Redistributions must also contain a
   *    copy of this document.
   *
   * 2. Redistributions in binary form must reproduce the
   *    above copyright notice, this list of conditions and the
   *    following disclaimer in the documentation and/or other
   *    materials provided with the distribution.
   *
   * 3. The name "DOM4J" must not be used to endorse or promote
   *    products derived from this Software without prior written
   *    permission of MetaStuff, Ltd.  For written permission,
   *    please contact dom4j-info@metastuff.com.
   *
   * 4. Products derived from this Software may not be called "DOM4J"
   *    nor may "DOM4J" appear in their names without prior written
   *    permission of MetaStuff, Ltd. DOM4J is a registered
   *    trademark of MetaStuff, Ltd.
   *
   * 5. Due credit should be given to the DOM4J Project - 
   *    http://www.dom4j.org
   *
   * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS
   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
   * METASTUFF, LTD. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
   * OF THE POSSIBILITY OF SUCH DAMAGE.
   *
   * Copyright 2001-2004 (C) MetaStuff, Ltd. All Rights Reserved.
   *
   * $Id: DOMDocument.java,v 1.15 2004/06/25 08:03:35 maartenc Exp $
   */