gnu.xml.dom
Class DomDocument

java.lang.Object
  gnu.xml.dom.DomNode
      gnu.xml.dom.DomDocument

All Implemented Interfaces:

Cloneable, Document, DocumentEvent, DocumentTraversal, EventTarget, Node, NodeList

public class DomDocument

extends DomNode

implements Document, DocumentTraversal

"Document" and "DocumentTraversal" implementation.

Note that when this checks names for legality, it uses an approximation of the XML rules, not the real ones. Specifically, it uses Unicode rules, with sufficient tweaks to pass a majority of basic XML conformance tests. (The huge XML character tables are hairy to implement.)

Version:

$Date: 2001/11/20 04:53:46 $

Author:

David Brownell

Field Summary

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

	DomDocument() Constructs a Document node, associating it with an instance of the DomImpl class.
protected	DomDocument(DOMImplementation impl) Constructs a Document node, associating it with the specified implementation.

Method Summary

Node	appendChild(Node newChild) DOM L1 Appends the specified node to this node's list of children, enforcing the constraints that there be only one root element and one document type child.
Attr	createAttribute(String name) DOM L1 Returns a newly created attribute with the specified name.
Attr	createAttributeNS(String namespaceURI, String name) DOM L2 Returns a newly created attribute with the specified name and namespace information.
CDATASection	createCDATASection(char[] buf, int off, int len) Returns a newly created CDATA section node with the specified value.
CDATASection	createCDATASection(String value) DOM L1 Returns a newly created CDATA section node with the specified value.
Comment	createComment(String value) DOM L1 Returns a newly created comment node with the specified value.
DocumentFragment	createDocumentFragment() DOM L1 Returns a newly created document fragment.
Element	createElement(String name) DOM L1 Returns a newly created element with the specified name.
Element	createElementNS(String namespaceURI, String name) DOM L2 Returns a newly created element with the specified name and namespace information.
EntityReference	createEntityReference(String name) DOM L1 Returns a newly created reference to the specified entity.
NodeIterator	createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean expandEntities) DOM L2 (Traversal) Returns a newly created node iterator.
ProcessingInstruction	createProcessingInstruction(String target, String data) DOM L1 Returns a newly created processing instruction.
Text	createTextNode(char[] buf, int off, int len) Returns a newly created text node with the specified value.
Text	createTextNode(String value) DOM L1 Returns a newly created text node with the specified value.
TreeWalker	createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion)
DocumentType	getDoctype() DOM L1 Returns the document's DocumentType, or null.
Element	getDocumentElement() DOM L1 Returns the document's root element, or null.
Element	getElementById(String id) DOM L1 (relocated in DOM L2) Returns the element with the specified "ID" attribute, or null.
DOMImplementation	getImplementation() DOM L1 Returns the document's DOMImplementation.
String	getNodeName() DOM L1 Returns the constant "#document".
short	getNodeType() DOM L1 Returns the constant DOCUMENT_NODE.
Node	importNode(Node copiedNode, boolean deep) DOM L2 Makes a copy of the specified node, with all nodes "owned" by this document and with children optionally copied.
Node	insertBefore(Node newChild, Node refChild) DOM L1 Inserts the specified node in this node's list of children, enforcing the constraints that there be only one root element and one document type child.
boolean	isCheckingCharacters() Returns true if certain expensive checks are performed.
Node	replaceChild(Node newChild, Node refChild) DOM L1 Replaces the specified node in this node's list of children, enforcing the constraints that there be only one root element and one document type child.
void	setCheckingCharacters(boolean value) Controls whether certain expensive checks, duplicating those that conformant XML parsers must perform, are made.
static void	verifyXmlName(String name) Throws a DOM exception if the specified name is not a legal XML 1.0 name.

Methods inherited from class gnu.xml.dom.DomNode

addEventListener, clone, cloneNode, compact, createEvent, dispatchEvent, getAttributes, getChildNodes, getElementsByTagName, getElementsByTagNameNS, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, isReadonly, isSupported, item, makeReadonly, nameAndTypeEquals, normalize, removeChild, removeEventListener, setNodeValue, setPrefix, trimToSize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.w3c.dom.Document

getElementsByTagName, getElementsByTagNameNS

Methods inherited from interface org.w3c.dom.Node

cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, isSupported, normalize, removeChild, setNodeValue, setPrefix

Constructor Detail

DomDocument

public DomDocument()

Constructs a Document node, associating it with an instance of the DomImpl class.

Note that this constructor disables character checking. It is normally used when connecting a DOM to an XML parser, and duplicating such checks is undesirable. When used for purposes other than connecting to a parser, you should re-enable that checking.

See Also:

setCheckingCharacters(boolean)

DomDocument

protected DomDocument(DOMImplementation impl)

Constructs a Document node, associating it with the specified implementation. This should only be used in conjunction with a specialized implementation; it will normally be called by that implementation.

See Also:

DomImpl, setCheckingCharacters(boolean)

Method Detail

getNodeName

public final String getNodeName()

DOM L1 Returns the constant "#document".

Specified by:

getNodeName in interface Node

getNodeType

public final short getNodeType()

DOM L1 Returns the constant DOCUMENT_NODE.

Specified by:

getNodeType in interface Node

getDocumentElement

public final Element getDocumentElement()

DOM L1 Returns the document's root element, or null.

Specified by:

getDocumentElement in interface Document

getDoctype

public final DocumentType getDoctype()

DOM L1 Returns the document's DocumentType, or null.

Specified by:

getDoctype in interface Document

getImplementation

public final DOMImplementation getImplementation()

DOM L1 Returns the document's DOMImplementation.

Specified by:

getImplementation in interface Document

getElementById

public Element getElementById(String id)

DOM L1 (relocated in DOM L2) Returns the element with the specified "ID" attribute, or null.

Returns null unless Consumer was used to populate internal DTD declaration information, using package-private APIs. If that internal DTD information is available, the document may be searched for the element with that ID.

Specified by:

getElementById in interface Document

appendChild

public Node appendChild(Node newChild)

DOM L1 Appends the specified node to this node's list of children, enforcing the constraints that there be only one root element and one document type child.

Specified by:

appendChild in interface Node

Overrides:

appendChild in class DomNode

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)

DOM L1 Inserts the specified node in this node's list of children, enforcing the constraints that there be only one root element and one document type child.

Specified by:

insertBefore in interface Node

Overrides:

insertBefore in class DomNode

replaceChild

public Node replaceChild(Node newChild,
                         Node refChild)

DOM L1 Replaces the specified node in this node's list of children, enforcing the constraints that there be only one root element and one document type child.

Specified by:

replaceChild in interface Node

Overrides:

replaceChild in class DomNode

verifyXmlName

public static void verifyXmlName(String name)

Throws a DOM exception if the specified name is not a legal XML 1.0 name. Actually this uses a very similar set of rules, closer to Unicode rules than to the rules encoded in the large table at the end of the XML 1.0 specification.

Throws:

DomException - INVALID_CHARACTER_ERR if the name isn't legal as an XML name.

setCheckingCharacters

public final void setCheckingCharacters(boolean value)

Controls whether certain expensive checks, duplicating those that conformant XML parsers must perform, are made.

isCheckingCharacters

public final boolean isCheckingCharacters()

Returns true if certain expensive checks are performed. Those checks are intended to reject illegal names, and characters that are illegal as XML characters.

createElement

public Element createElement(String name)

DOM L1 Returns a newly created element with the specified name.

Specified by:

createElement in interface Document

createElementNS

public Element createElementNS(String namespaceURI,
                               String name)

DOM L2 Returns a newly created element with the specified name and namespace information.

Specified by:

createElementNS in interface Document

createDocumentFragment

public DocumentFragment createDocumentFragment()

DOM L1 Returns a newly created document fragment.

Specified by:

createDocumentFragment in interface Document

createTextNode

public Text createTextNode(String value)

DOM L1 Returns a newly created text node with the specified value.

Specified by:

createTextNode in interface Document

createTextNode

public Text createTextNode(char[] buf,
                           int off,
                           int len)

Returns a newly created text node with the specified value.

createComment

public Comment createComment(String value)

DOM L1 Returns a newly created comment node with the specified value.

Specified by:

createComment in interface Document

createCDATASection

public CDATASection createCDATASection(String value)

DOM L1 Returns a newly created CDATA section node with the specified value.

Specified by:

createCDATASection in interface Document

createCDATASection

public CDATASection createCDATASection(char[] buf,
                                       int off,
                                       int len)

Returns a newly created CDATA section node with the specified value.

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(String target,
                                                         String data)

DOM L1 Returns a newly created processing instruction.

Specified by:

createProcessingInstruction in interface Document

createAttribute

public Attr createAttribute(String name)

DOM L1 Returns a newly created attribute with the specified name.

Specified by:

createAttribute in interface Document

createAttributeNS

public Attr createAttributeNS(String namespaceURI,
                              String name)

DOM L2 Returns a newly created attribute with the specified name and namespace information.

Specified by:

createAttributeNS in interface Document

createEntityReference

public EntityReference createEntityReference(String name)

DOM L1 Returns a newly created reference to the specified entity. The caller should populate this with the appropriate children and then mark it as readonly.

Specified by:

createEntityReference in interface Document

See Also:

DomNode.makeReadonly()

importNode

public Node importNode(Node copiedNode,
                       boolean deep)

DOM L2 Makes a copy of the specified node, with all nodes "owned" by this document and with children optionally copied. This type of standard utility has become, well, a standard utility.

Note that EntityReference nodes created through this method (either directly, or recursively) never have children, and that there is no portable way to associate them with such children.

Note also that there is no requirement that the specified node be associated with a different document. This differs from the cloneNode operation in that the node itself is not given an opportunity to participate, so that any information managed by node subclasses will be lost.

Specified by:

importNode in interface Document

createNodeIterator

public NodeIterator createNodeIterator(Node root,
                                       int whatToShow,
                                       NodeFilter filter,
                                       boolean expandEntities)

DOM L2 (Traversal) Returns a newly created node iterator. Don't forget to detach this iterator when you're done using it!

Specified by:

createNodeIterator in interface DocumentTraversal

See Also:

DomIterator

createTreeWalker

public TreeWalker createTreeWalker(Node root,
                                   int whatToShow,
                                   NodeFilter filter,
                                   boolean entityReferenceExpansion)

Specified by:

createTreeWalker in interface DocumentTraversal